写作是一门后天习得的技能。没有哪个人是优秀的作家或糟糕的作家。
当同事请我指导他们进行技术写作时,我会搜索一篇涉及三个关键问题的技术写作文章、指南、书籍或教程:
人们如何使用和阅读技术文档
好的标题如何帮助读者和作者
某些工具如何帮助你修改内容,使其更简洁
我发现了什么
好吧,我详尽的搜索让我深入互联网并回来了。我找到了西方世 多米尼加共和国 whatsapp 号码数据 5 界最古老的¹ 技术文档范例(它真的存在吗?!)对与软件无关的领域缺乏技术文档的同情²(它真的存在吗?!)以及我记得看过并喜欢的技术写作会议³ 的过去视频,但忘了保存(呼,它确实存在)。
但-
我还是没有找到我想要的东西。所以我只剩下两个选择:
为我的同事提供各种技术写作资源:文章、指南、书籍和课程。
创建一个关于技术写作的单独教程,包含我所寻找的三件事。
我做了什么
我选择了第二种选择。作为一个正在学习新知识的读者,我讨厌被引导到多个资源中——“直接告诉我就行了!”我不希望我的同事有这种经历,尤其是我最喜欢的同事。
我把教程分成了四个部分。通过遵循每个部分,读者可以将一张空白页变成一页技术文档。但他们也学到了很多东西;比如:
如何区分内容类型,例如操作指南和教程
如何构建内容以满足读者的目标
如何起草内容
如何修改内容
如何组织文档集合
如何加入技术写作社区并发展壮大社区
如何开始
本教程将分五部分在本博客中发布。现在您可以随意浏览备忘单,但尽量不要立即使用它们。在浏览每一部分时,您将了解备忘单为何如此。