许多工程师和工匠对他们使用的工具有特殊的要求。要完成工作,您需要最好的工具和使用它们的技能。软件开发中最好的工具也可以在数字创作的其他领域发挥强大的作用。DocumentasCodeDocsasCode文本格式和源文件控制从传统的写作平台切换到documentascode方式时,主要的调整是将写作内容保存为基于文本的标记格式。这种转变使得基于纯文本的工具适合于文档编写。无论您选择DocBook、Markdown还是其他标记语言,从仅使用一种工具到使用多种工具的标准格式都是一个巨大的转变。寻找支持您的工作流程的工具非常重要。许多开发人员在文档即代码项目中使用他们的代码编辑器。由于他们已经是这些工具的高级用户,所以一切都很顺利。寻找适用于团队中其他专业人员(例如技术作家、编辑、信息架构师和文档产品所有者)的工具可能需要一些工作。以下是一些可供考虑的选项:各种优秀的Markdown编辑器之一具有良好预览工具的代码编辑器可能更适合非程序员流行的Git托管服务的Web界面特别适合偶尔需要的贡献者一旦内容安全以标记语言格式存储,可以使用Git等版本控制进行管理。Git具有比大多数文档平台更多的功能:清晰详细的文档版本历史记录:谁在何时更改了什么。如果您有良好的提交消息约定,您甚至可以了解进行更改的原因。简洁的并行修改过程。在Git中使用分支意味着任何人都可以进行他们想要的任何更改,并且最终合并这些更改。高级协作和审阅工具。所有源代码控制平台都旨在根据需要支持对每个更改和讨论的审查,以使每个人都相信更改可以继续进行。自动质量检查,例如拼写检查和链接检查。这不仅可以节省时间,还可以发现可能遗漏的错误。源代码控制有很多优点。但请记住,如果您刚开始使用源代码管理,它有一个学习曲线。这里有一些优秀的学习资源和文章,可以帮助作家入门。您还可以让好奇的文档编写者找到对他们有用的学习材料,而不是让您的工程师培训他们。(问我是怎么学会的?——当然是艰难的方式!)拉取请求和审查周期所有源代码控制平台都围绕拉取请求展开拉取请求最强大的协作工具是diff,它可以显示旧版本之间的区别版本和新版本以易于理解的方式。该工具有许多不同的版本,可以使比较视图更易于查看:双列模式、内联模式,甚至渲染的Markdown模式。团队的每个成员都可以选择最适合他们的工具。例如,web视图通常用于查看小的变化,而对于较大的变化,我习惯于使用vimdiff或Meld在本地浏览。评论可以添加到整个修订版或建议更改的个别行。一些项目限制一行的最大长度,即硬换行,或每行一个句子,以便更容易地向文本的特定部分添加注释。在审核过程完成并接受修订之前,可以添加进一步的修订和评论。由于拉取请求在项目存储库中排队,这是显示当前正在进行的内容和需要检查的内容的好方法。diff工具使审阅者更容易添加他们的想法。尤其是当您与技术人员一起工作时,您可以从他们那里获得对他们每天使用的工具的评论。持续集成和部署以纯文本形式提供文档的源代码有很多好处,您可以轻松找到每个需要修改的位置,您可以使用现有工具,如wc、grep或tree,以处理潜在的大型文档集。当您将这些与源代码控制平台结合使用时,您可能会有更多可用的工具,而且它们都是开源的。另一个巨大的工作流程改进是持续部署的能力。简单来说,这意味着每当将拉取请求合并到主项目中时,该项目就可以直接自动部署到位。如果更改足以进入项目,那么它也足以帮助文档站点上的读者。通常,持续部署是在单独的自动化服务器上??配置的,例如Jenkins或Githooks。无论哪种方式,基于文本的标记语言与文档即代码平台(通常是静态页面生成器,如Hugo或Sphinx)结合生成文档网站,然后自动部署。相同的自动化过程可用于在部署之前检查要合并的拉取请求。在编程项目中,由计算机本身执行代码检查、代码测试和其他质量检查已变得司空见惯。文本可以通过Vale等工具进行检查,文档项目也可以同样对待。您还可以添加其他工具,例如添加链接检查器以确保文本中的所有链接都有效。用于文档流程的编码工具工程师了解和喜爱的工具是非常好的工具,也可以用于其他类型的项目。对于文档,它们增加了宝贵的效率,特别是如果您希望您的文档与您的团队同步移动。上面讨论的所有工具都是开源的,您可以自己试用,或者为大型全球团队部署它们,或者介于两者之间。愿你的写作过程像你的编程过程一样顺利。
