技术文档、工具与职业发展——独立技术写作杂志
TECHWRITERS.ORG

档案

重新审视过去的观点、工具与争论,而不是让它们被遗忘。

文章《文档工具的过去与现在:真正改变了什么》的技术编辑风格插图。
档案

文档工具的过去与现在:真正改变了什么

格式和发布流水线变化巨大,但长期问题依旧熟悉:源文件控制、复用、导航、review,以及让已发布信息与产品保持同步。 在“Docs-as-Code”这个名字出现之前,文档团队已经在处理多个源文件、共享片段、版本手册,以及“哪一份才是最新”的问题。

2 分钟阅读
文章《那些经受住时间考验的老文档问题》的技术编辑风格插图。
档案

那些经受住时间考验的老文档问题

工具名称变化很快,但术语、所有权、截图、复用和审核的问题一直回来,因为它们反映的是更深层的系统设计选择。 技术答案从共享目录变成 repository 和 ownership rule,但组织问题没有改变。

2 分钟阅读
现代文档门户之前的超文本
档案

现代文档门户之前的超文本

围绕“现代文档门户之前的超文本”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“现代文档门户之前的超文本”,重点是可执行、可验证和可维护的做法。

当用户手册随 CD 一起交付
档案

当用户手册随 CD 一起交付

围绕“当用户手册随 CD 一起交付”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“当用户手册随 CD 一起交付”,重点是可执行、可验证和可维护的做法。

2 分钟阅读