本文详细介绍了如何通过清晰的文档结构、内容组织和关键信息突出，使读者能够快速理解文档的目的、工作原理、局限性和与其他解决方案的比较。特别强调了在阅读文档时的思维模式转换，以及对他人文档经验的借鉴。
The Standard ( First Draft)
There should also be a clear order to the sections (five sections). Two of the sections I propose (IV and V) will have non-linear content within, but the overall starting point should be obvious to the newcomer. One shouldn't need to "figure out" how to read the documentation.
In the following sections I frequently write as if you are the documentation reader, not the writer. I do this to put you in what I hope is a useful mindset. It's hard to make yourself unfmailiar with your own project so it's good to think about experiences you've had with other peoples' documentation.
What it is and why you might want to use it
- what problems it solves
- how it works (environment, dependencies)
- its shortcomings
- what it's not intended for
- how it compares to alternatives
扫一扫
6207
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
