对于您开发和销售的任何软件产品,都需要详尽的文档。 要创建它,您需要实现许多功能,从说明如何使用它的屏幕截图和视频到针对消费者的实时聊天和调查。 要实现这一点,您需要 技术文档工具 那…
轻松写作和复习
当你写一部小说时,你应用了你的创作风格。 当您编写技术文档时,您遵循这些准则。 创作包括写作、编辑和设计。 文档不仅应该正确描述软件的功能。 它需要写得全面,格式化为读者最容易理解的方式。
请记住这些作品的最终目标。 客户对您的产品的使用有疑问并希望得到答案。 他们可能对您的产品有问题,需要故障排除指南。 最后,当事情变得严重时,他们可能会寻求个人支持。 他们应该能够在您的客户文档中找到所有内容。 至于内部文档,它应该包含开发人员必须强调的关于他们工作的所有内容。
在团队中工作
创建文档是一个漫长的过程,涉及众多的作者、编辑、设计师、经理等。你的产品本身的开发人员也需要在你的范围内,以清除对新功能的任何误解,并在即将到来的新功能中向作者补充版本。
为了有效地安排工作,经理需要特殊的工具来:
- 向员工分配任务
- 设定最后期限
- 建立依赖
- 创建子任务
等等。 它们应该与编辑器和云存储文档集成,以便于共享、查看和交换评论和编辑。 内置的 Messenger 也是避免在环境之外共享链接和文件的好东西。 最后,可调整的访问权限可以授予团队成员编辑或查看相关文档的可能性。
风格规则
现在必须以所有可能的方式将您的文档门户与软件集成,包括样式。 您公司的标志、配色方案、使用的字体——产品本身和文档之间的过渡应该尽可能顺畅。
在潜意识层面上,它似乎是产品的逻辑延伸。 但这需要创作者的大量有意识的努力。 因此,文档创建工具需要具有设计器功能,以便您可以以最有机的方式设计文档。 或者在别处设计,用你最喜欢的软件,然后导入。
听你的心
但毕竟,如果你有能力选择软件,试着决定你是否凭直觉去感受。 所有图标和工具都属于它们所在的位置吗? 使用它是否容易,创建文档、日程表、时间表,从其他平台导入文档,或者将它们导出为您将在公司站点上托管的 Web 帮助门户? 如果是,这应该是您的选择。 这种内心的声音就像您的客户的意愿一样。
发表评论
有话要说关于这篇文章? 添加您的评论并开始讨论。