Re: PPIG discuss: Documentation for large systems

2007-12-08 Thread Michael Kölling
On 6 Nov 2007, at 19:25, Boris Ouretskey wrote: You are welcome to visit www.wikipedia.org and convince yourself that is far away from being myth. That's an entirely different use case. That does not prove anything about wikis for managing projects or creating documentation. There are

Re: PPIG discuss: Documentation for large systems

2007-11-08 Thread Peter Gutmann
William Billingsley [EMAIL PROTECTED] writes: So theoretically, 20% of the team have just gone through this learning process. What did they misunderstand? What questions were they asking their mentors and why. There's a good discussion of this (with a worked example) on Hacknot:

Re: PPIG discuss: Documentation for large systems

2007-11-07 Thread Andrew Walenstein
Ruven E Brooks wrote: 3. I didn't rule out active discovery of content. In fact, that's what people do today in our organization; they look at the code and analyze the code, using tools of varying degrees of sophistication. The problem is, it's terribly time consuming, and the same discovery

Re: PPIG discuss: Documentation for large systems

2007-11-07 Thread William Billingsley
So theoretically, 20% of the team have just gone through this learning process. What did they misunderstand? What questions were they asking their mentors and why. Ask if you can read the notes they made, and interview them about those notes -- which bits actually turned out to be

Re: PPIG discuss: Documentation for large systems

2007-11-07 Thread Tom Wheeler
Ruven E Brooks [EMAIL PROTECTED] writes: I have just been given the assignment of investigating techniques for documenting a 1.5 million line system. Suppose that you were hired (at an outrageous salary, of course) to be the chief architect of this system. If you could have a 20 page

Re: PPIG discuss: Documentation for large systems

2007-11-07 Thread Ruven E Brooks
Let me elaborate a bit on my original request. 1. I'm assuming that most or all of the previous developers/architects of the system are unavailable. All that's left are the artifacts, code plus whatever else. There's no one to talk to about where to start, etc. or about the overall

Re: PPIG discuss: Documentation for large systems

2007-11-06 Thread Derek M Jones
Ruven, I have just been given the assignment of investigating techniques for documenting a 1.5 million line system. Who will be the reader of these documents? If the readers are going to be software developers working on the source do you think the exercise will be cost effective? After all,

Re: PPIG discuss: Documentation for large systems

2007-11-06 Thread Ruven E Brooks
[EMAIL PROTECTED] wrote on 11/06/2007 10:21:14 AM: Who will be the reader of these documents? If the readers are going to be software developers working on the source do you think the exercise will be cost effective? After all, if there are only going to be a few readers and they are only

Re: PPIG discuss: Documentation for large systems

2007-11-06 Thread Daniel Ratiu
If you could have a 20 page initial document on the internal structure of this system, what would that document contain? My own initial thought was some kind of box-and-line major subsystems document but the exact semantics of the boxes and the lines is still open.   Beside the major

Re: PPIG discuss: Documentation for large systems

2007-11-06 Thread Frank Wales
Ruven E Brooks wrote: I have just been given the assignment of investigating techniques for documenting a 1.5 million line system. Suppose that you were hired (at an outrageous salary, of course) to be the chief architect of this system. If you could have a 20 page initial document on the

Re: PPIG discuss: Documentation for large systems

2007-11-06 Thread Andrew Walenstein
Ruven E Brooks wrote: Suppose that you were hired (at an outrageous salary, of course) to be the chief architect of this system. If you could have a 20 page initial document on the internal structure of this system, what would that document contain?... Other thoughts, suggestions are welcome.

Re: PPIG discuss: Documentation for large systems

2007-11-06 Thread William Billingsley
Ruven, I'm a man with a hammer, so I'm interested in finding out whether your problem might be a nail... From the issue you've described (it's difficult to know where to start and what to read), it sounds like the shortage is not in the detailed documentation per se, but in an

Re: PPIG discuss: Documentation for large systems

2007-11-06 Thread Michael Kölling
On 6 Nov 2007, at 18:53, Boris Ouretskey wrote: Anyway to document large system it is obligatory to use wiki pages (and a lot of time of cause) and give all the company an opportunity to participate in the process. Wiki? Obligatory?? I don't believe in wikis at all. I know there is

RE: PPIG discuss: Documentation for large systems

2007-11-06 Thread Boris Ouretskey
For the first document I'd rather have a presentation with notes. They seem to convey high level information more effectively. Anyway to document large system it is obligatory to use wiki pages (and a lot of time of cause) and give all the company an opportunity to participate in the process.

RE: PPIG discuss: Documentation for large systems

2007-11-06 Thread Brad Myers
, PA 15213-3891 (412) 268-5150 FAX: (412) 268-1266 [EMAIL PROTECTED] http://www.cs.cmu.edu/~bam _ From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Ruven E Brooks Sent: Tuesday, November 06, 2007 11:57 AM To: discuss@ppig.org Subject: Re: PPIG discuss: Documentation for large

RE: PPIG discuss: Documentation for large systems

2007-11-06 Thread Boris Ouretskey
as a documentation solution has to fit the culture of the users or developers. - Original Message From: Boris Ouretskey [EMAIL PROTECTED] To: Michael Kцlling [EMAIL PROTECTED]; discuss@ppig.org Sent: Tuesday, November 6, 2007 1:25:31 PM Subject: RE: PPIG discuss: Documentation for large systems

Re: PPIG discuss: Documentation for large systems

2007-11-06 Thread Andrew Walenstein
Gaspar, Alessio (USF Lakeland) wrote: I can understand the love'em / hate'm positions regarding wikis, however I couldn't help but notice that some of the arguments below are very close to what used to be said by corporations about open source projects and development methodologies All wikis

RE: PPIG discuss: Documentation for large systems

2007-11-06 Thread Gaspar, Alessio (USF Lakeland)
: Tuesday, November 06, 2007 14:16 To: discuss@ppig.org Subject: Re: PPIG discuss: Documentation for large systems Wiki? Obligatory?? I don't believe in wikis at all. I know there is (still) a lot of hype around them, but I think it is a complete myth that they work. There is somehow the wishful

RE: PPIG discuss: Documentation for large systems

2007-11-06 Thread Boris Ouretskey
there is a critical point after which wiki will loose its value. Thanks -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Gergely Buday Sent: Tuesday, November 06, 2007 11:17 PM To: Boris Ouretskey Cc: Michael Kцlling; discuss@ppig.org Subject: Re: PPIG discuss

Re: PPIG discuss: Documentation for large systems

2007-11-06 Thread Gergely Buday
Michael wrote: The result, much more often than not in my experience, is a document that nobody takes responsibility for, that has very weak overall structure, and random level of detail over various parts. No guarantee that important information is represented appropriately at all. I'd