|
Post by account_disabled on Dec 3, 2023 23:41:49 GMT -8
需要能够有效地与非技术人员进行技术交流。 首先为技术文档制定一个好的计划。该计划需要列出所需的技术文档类型,并定义每种文档的目标受众。他们是技术知识有限的最终用户还是熟练的技术人员?还要列出谁将开发、谁将批准以及开始和完成该文档的预计日期。 查看有关您要撰写的主题的现有信息。向主题专家寻求有关该主题的信息。这可以帮助您缩短开发技术文档所需的时间。 此外,与用户进行访谈,以获得有关所写主题的非技术信息。关于软件的技术文档就是一个例子。在这里,用户的想法可以帮助您了解如何向他们传达有关特定软件的信息。 接下来,您需要制定一个大纲。这是如何编写文档的结构。这应该遵循逻辑顺序,缩进大纲项目,以便相关或相似的项目都位于同一级别。 如果需要的话,也准备好进行未来的修订。 开始写 电话号码清单 文档。确保文档清晰简单。尤其是当您的目标受众涉及非技术人员时,应该这样做。您可以使用播放脚本写作风格来编写面向任务的技术文档。在这种风格中,项目的编写方式类似于戏剧剧本,其中有详细的分步说明,详细说明了执行每个动作的人员。这个系统非常容易理解。在文档中插入所有相关参考文献。 网络周围 赞助 停止为您的处方支付太多费用 - 比较价格、查找免费优惠券、 Stop Paying Too Much for Your Prescriptions - Compare Prices, Find Free Coupons,停止为您的处方支付太多费用 - 比较价格、查找免费优惠券、 利用图形。这些打破了书面技术信息并使其更易于阅读。要考虑的常用图形形式是显示相关项目的流程图。 在流程聊天中添加内容的示例是特定过程中涉及的步骤。其他可能适用的图形可能包括显示产品不同视图的产品照片。 现在你已经迈出了非常重要的一步。找一位精通所写领域的有能力的编辑和校对员来检查您的工作。对他们的建议持开放态度。如果目标受众是最终用户,请向最终用户提供文档以供其阅读并给予评论。最终用户将帮助您判断产品是否易于理解。 最后,发布文档并让它分发给目标受众。您可以自行打印和复印或外包文档。保留电子版,也可以通过电子邮件分发。这些步骤使任何有兴趣编写技术文档的人都可以轻松完成。 00
|
|