如何写好技术文档 — 来自十多年的文档经验总结
地页的问题就是随着时间的推移,页面可能会变的越来越乱,而且有些内容会失效,不过这些问题都好解决,做好定期的维护和整理就行。 落地页的技术难度不高,但要求内容的有效性、完整性和分类清晰。 ## 文档Review ## 在一个组织内,光靠个人去维护文档是不行的,必须得借助群体的智慧。在一个组织内部,文档的变更也应该像代码的变更一样,需要被其他人Review,以提前发现其中的问题并提升文档的质量。 如何Review文档: - **专业的视角来保证准确性**: 一般由团队里比较资深的人负责,他们关注的核心点是文档写的对不对,专不专业。如果Code Review做的好的话,文档的Review也属于Code Review的一部分。 - **读者视角保证简洁性**: 一般由不熟悉这个领域的人来Review...阅读全文