| ??? 04/01/05 15:55 Read: times |
#90816 - I use similar methods Responding to: ???'s previous message |
I also think that all documentation should be done in the program code itself. If any special procedures are needed to access certain sections of program. (eg pressing two keys at once), they should be documented in the program code. Then for end-user documentation the rough draft can be taken from the program code. I start with a template containing all the usual stuff, date, project description, hardware required, etc. Then outline the different sections needed like Erik described. I then time stamp changes made, bugs found, problems encountered during the course of the project.
Jon |
| Topic | Author | Date |
| Firmware Documenation and Planning | 01/01/70 00:00 | |
| Firmware doc | 01/01/70 00:00 | |
| Code Complete | 01/01/70 00:00 | |
| Some tips | 01/01/70 00:00 | |
| my experience and methods | 01/01/70 00:00 | |
| I use similar methods | 01/01/70 00:00 | |
| I agree... | 01/01/70 00:00 | |
| Read Jack Ganssle | 01/01/70 00:00 | |
| Will check this out | 01/01/70 00:00 | |
| mil-std-2167 | 01/01/70 00:00 | |
| Hardware documentation? | 01/01/70 00:00 | |
Hardware documentation? (different) | 01/01/70 00:00 |