It's equally important to consider documentation as part of the product. As such, documentation should be built to be adaptable, extensible, and scalable. All things knowledgeable technical communication professionals do everyday. 🤠
Yeah, especially when working on a large software system, documentation will become more important for people to communicate and reference. I have another article to summarize my tips for writing documentation (https://blog.awesomesoftwareengineer.com/p/tips-for-writing-good-documentation). Usually, design document should be created before any coding. After coding, we might need to add more technical details to supplement what readers need in order to help them understand the critical design of the system/feature. The more you write, the more new things you can create and the better communication between you and others.
Thanks for sharing the post. Great ideas.
It's equally important to consider documentation as part of the product. As such, documentation should be built to be adaptable, extensible, and scalable. All things knowledgeable technical communication professionals do everyday. 🤠
Yeah, especially when working on a large software system, documentation will become more important for people to communicate and reference. I have another article to summarize my tips for writing documentation (https://blog.awesomesoftwareengineer.com/p/tips-for-writing-good-documentation). Usually, design document should be created before any coding. After coding, we might need to add more technical details to supplement what readers need in order to help them understand the critical design of the system/feature. The more you write, the more new things you can create and the better communication between you and others.