对于只想要一个问题的解决方案并且不想通过大量详细文档来查找它的最终用户来说尤其如此。在您准确弄清楚您的受众是谁之后请明确并决定文档的适当范围。许多文档都以入门文档开头这是一个好主意。这告诉读者在开始之前应该了解的事情。它概述了文档的内容以及文档中未包含的内容以及在哪里可以找到后者。
教程通常构成
文档的主要内容并且可以附有参考 洪都拉斯 WhatsApp 号码列表 指南定义一些术语解释一些功能并给出一些示例。教程更具对话性而参考指南则更加事实和客观。然而在写这两篇文章时始终牢记你的读者是很重要的。想想你的听众在每一步之后可能会提出什么问题以及他们当前的知识和技能水平可能是什么。很大一部分受众只想解决一个迫在眉睫的问题这是完全合理的这就是常见问题解答常见问题或食谱部分最有用的地方。
这些文档领域提
供了最终用户正在寻找的直接解决方案。在提供示例时请记住事先测试这些示例并推广最佳实践而不仅仅是最简单或最快的解决方案。测试和校对你的工作一旦您写下了文档中需要包含的所有内容最后一步就是校对。这是您确保观众清楚理解您所写内容的部分。当你校对时不仅要关快 铅蓝 地注你所说方式。除了基本的语法和拼写之外校对时还应该注意一些不清楚重复或填充的单词。
