撰写技术文档的formula

1. 提供一个Quick Start,里面要包括可以在3分钟内运行起来的Demo

2. 文档的写法要先概括,后细节;先简单,后复杂。永远不要假设你的读者原意读,他们只是想解决问题

posted @ 2020-03-17 09:39  redstar9451  阅读(87)  评论(0编辑  收藏  举报