Documentation
Kim R. Fowler, IEEE Fellow, Consultant
Documentation conveys the right information to the right person at the right time. Documentation is corporate communication and memory. Every project needs it, otherwise the work cannot be replicated or fully understood.
Everyone working on a technical project spends a lot of time preparing documentation. Documentation is a form of communication and occupies between 50% and 80% of your time on a project.
This chapter has a number of suggested outlines and templates of documents. It also has examples of content within important documents.
Keywords
Plans; reports; instructions; project documentation; ICD; user’s manual; design descriptions; test plan
Get Developing and Managing Embedded Systems and Products now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
