| ??? 04/03/06 08:34 Read: times |
#113543 - Two categories Responding to: ???'s previous message |
I've been thinking about this for some time now. I've come to the conclusion that documentation falls into two categories.
Structured The requirements, specifications, quality plans, test strategies, schematics, sources and test results are formal documents which should be kept in a structured system under revision control (I'm a big fan of revision control software, even for one man projects). Most big organisations will have a system in place, and it's pretty much mandatory if you work to quality standards like ISO9001. Unstructured There is a bunch more information which is important but which doesn't fit in to a structured system. Most engineers use a lab book or project book or day book. This is much better than nothing, but I think that electronic versions have something to offer. I'm starting to use a wiki to capture information which I think is important, and I like the idea of project blog. |
| Topic | Author | Date |
| How do you manage Documentation? | 01/01/70 00:00 | |
| As soon as you finish?? | 01/01/70 00:00 | |
| User Manual | 01/01/70 00:00 | |
| it all is very simple | 01/01/70 00:00 | |
| too late and totally wrong | 01/01/70 00:00 | |
| you have an easy life won't you | 01/01/70 00:00 | |
| Of course, you only have enough informat | 01/01/70 00:00 | |
| more on the above, the beauty of the hoo | 01/01/70 00:00 | |
| in C? | 01/01/70 00:00 | |
| please do not accuse me of unnatural act | 01/01/70 00:00 | |
| Design Info | 01/01/70 00:00 | |
| viewpoint | 01/01/70 00:00 | |
| General Principles | 01/01/70 00:00 | |
| the clients... | 01/01/70 00:00 | |
| Client Variety | 01/01/70 00:00 | |
| It's like I said last month ... | 01/01/70 00:00 | |
| Great | 01/01/70 00:00 | |
| I, J OK | 01/01/70 00:00 | |
| Repetition | 01/01/70 00:00 | |
| My old DOS based suite... | 01/01/70 00:00 | |
| Two categories | 01/01/70 00:00 | |
MIL498 | 01/01/70 00:00 | |
| write the documentation first | 01/01/70 00:00 | |
| Good points.. | 01/01/70 00:00 |