优秀技术作家的11项技能( 二 )


系统化
软件文档是一个系统 。 一些用户指南可能会变得如此庞大和复杂 , 并且塞满了帮助文章 , 以至于很难相信它是一个系统 。 好吧 , 也许 , 它不再是了 。 而且 , 这很糟糕 。
首先 , 结构不良的文档破坏了用户体验 , 因为它无法实现其主要功能-为人们提供易于访问的数据 。
其次 , 文档编写者也遭受了损失 。 当没有系统时 , 维护[用户指南]真的很难 。
因此 , 一个好的技术作家总是提前计划文档结构 , 并且永远不会弄得一团糟 , 希望以后能清理干净 。
团队合作
技术文档团队是更大机制的一部分 。 他们必须能够[与其他部门进行良好的沟通] 。
优秀技术作家的11项技能
文章图片
技术作家需要相互交谈 , 编辑 , 设计师 , 开发人员......
起初 , 技术写作似乎是内向者的工作 , 但这种表象是欺骗性的 。 不要忘记由技术传播者制作和为技术传播者制作的所有会议!
问题是-用户指南只有在其作者知道一切如何运作时才能清晰且有意义 。 所以 , 总是有很多关于各种事情的沟通和询问 。
擅长单一采购
你可以为技术作家使用一个工具 , 但永远不会完全意识到它的潜力 。 [单一来源]对于任何技术作家来说都是节省时间的 。 如果你想能够在不费吹灰之力的情况下完成更多的事情 , 你应该学习这些技巧 。
基本上 , 单一来源允许使用相同的源创建多个文档 。 例如 , 有一个任务是创建用户指南的专业版和初学者版 。 使用单一来源 , 您可以只创建一个文档 , 标记仅供专业人士使用的部件 , 并获得两个不同的文档作为输出 。
另一个例子是在文档项目中使用变量 。 您可以使用产品版本创建一个变量(一种用于保留某些数据的容器) 。 这样 , 稍后 , 您只需更改一次变量值即可更改文档中的版本 。
社会学
了解社会学的基础知识是一项非常有用的技术沟通技巧 。
技术文档是为某些产品或服务的用户创建的 。 每个产品或服务都有其核心用户群和目标受众 。 任何技术作家的任务之一就是弄清楚谁是最终用户 。 一旦完成 , 就可以开始编写过程 。
最简单的例子是B2C和B2B用户指南之间的差异 。 在第一种情况下 , 解释必须非常简单 , 并且有点脚踏实地 。 而在第二种情况下 , 内容应该更深刻 , 更复杂 , 更详细 。
就文档创作而言 , 社会学是了解读者的想法 , 并找出为社会这一特定部分提供内容的最佳方式 。
优秀技术作家的11项技能
文章图片
批判性思维
批判性思维是一个广义的术语 。 而且 , 这似乎是技术作家最必要的技能之一 。
基本上 , 批判性思维可以解释为做出合理和清晰判断的能力 。
这个概念包括收集信息 , 分析和系统化信息 。 只是系统化只是整个批判性思维故事的一小部分 。
是什么造就了一个好的批判性思考者?好吧 , 关于这个问题的大多数理论都在说 , 答案是个人经验 。 而且 , 这确实是有道理的 。 获取和处理信息的整个过程越有意识 , 输出就越清晰 。
网页设计基础
此技能是可选的 。 但是 , 近年来表明 , 在记事本上写作已经不够了 。 市场上出现了越来越多的在线文档工具 。 其中一些提供了现成的模板 , 您可以按原样使用或根据自己的喜好进行调整 。 而且 , 调整也可以使用HTML和[CSS]完成 。
即使我们从UX的角度来看-设计可以改善或破坏UX-糟糕的配色方案 , 丑陋的屏幕截图......用户肯定不会对此感到满意 。