逆行工具

我们已经达到了技术写作的临界点,我们需要应对它。

未来将不再涉及生成文档,而是将在产品中及其周围产生无缝集成的内容,这意味着我们需要改变对工具的期望。 这会很痛苦,但是希望以一种好的方式。

当我开始写作时,我学习了FrameMaker。 这是惊人的。 即使到那时,它也已有20年的历史,您可以做任何事情。 公式,打印机的裁切标记,自动将文本块换入和换出,从同一文件生成打印文件,PDF和帮助文件,以及更改交叉引用的操作。 使用Frame与艺术和科学一样多,并且有一些关键命令通过口耳相传在邮件列表中传输,因为它们不再存在于官方文档中。 它的学习曲线像一堵砖墙,但是一旦您通过它,您就会驾驶一辆势不可挡的战车,它可以解决任何问题。

15年后,包括偶尔痛苦地尝试使用Microsoft Word做专业文档,我们得到了一种新的热门产品,称为MadCap Flare。 就像FrameMaker已被转用于网络一样。 它易于使用,具有本地化,CSS,HTML5的集成。 它闪闪发光,美丽而有力。 我仍然可以执行条件文本,引用的文本块和单一来源。

我已经有18个月没有使用过这样的技术写作工具了,而且我认为它会越来越少地出现。

软件即服务和应用程序文化的兴起使我们远离了用户指南,管理指南和安装指南。 我们希望获得的弹出气泡和界面会代替CD上的说明,引导我们完成应做的工作。 这很有意义,因为我们都基于带宽,应用冲突,需求和许可结构来体验个性化的体验。 编写一个文档,其中包含使用旧工具很难做到的所有事情,而我们已经没有旧工具了。

我们没有它们,因为不需要制作正式文档,我们减少了并消除了技术写作部门和工作。 我们正在将大量工作移至“用户体验”中,并要求仍然作为开发人员生产的内容交换所的作家。 我们现在不是聚合模型,而是采访集合开发人员或嵌入团队的新闻模型,而是从多个来源获取内容并准备分发。 还是没有作家,而出版则是临时性的。

FrameMaker和Madcap Flare的每个牌照费用为$ 1000到$ 2000。 对于那些兼职的人来说,这不是您要购买的东西。 由于工具中附带了所有图元文本和已编译的信息,因此很难将数据移入或移出它们。 这是一个数据库,而不是一组平面文件。 更准确地说,它是一个编译的二进制文件,而不是程序,文档。 因此,使用这些工具之一的作者对于团队发表自己的著作的能力而言将是一项艰巨的任务。 看起来不错,但您会遇到单点故障。

相反,我们一直在努力让技术作者使用开发人员可以免费使用的工具。 用readthedocs或readme.io或其他钝器工具编译的Markdown可以创建包含目录和一些最小链接的页面。 这样做的好处是每个人都可以阅读,编写和访问文档。 不利的一面是,只有技术作者才能看到,但不利的一面是,我们在将文档视为面向对象的编译对象方面失去了极大的丰富性。

以下是一些我做不到或很难做的事:

  • 条件文本-基于在整个文档上设置的标志的不同输出文本。
  • 白标签-配置我的文档,以便二级组织可以自己对它们进行品牌化
  • 智能本地化-根据常用单词和短语进行批量本地化,减少翻译时间和成本
  • 一次编写/多次发布-具有可提供帮助,网页,印刷和产品内协助的主文档
  • 与用户所在页面相关的上下文相关帮助
  • 表格-Markdown,您为什么这么不好?
  • 复杂的布局-页眉,页脚,面包屑,插图图像和文本块
  • 自动提取和格式化其他文件格式
  • 包括引用的文本,插入的文件-思想库

损失很多! 有时候,我觉得用Markdown写作就像是让Gutenberg放弃印刷机,向他展示愤怒的鹅和卷曲的羊皮。

但是,哀叹技术写作工具“罗马时代”的失落荣耀对我没有任何好处,因为我们现在正处在黑暗时代,我们只需要尽快进入启蒙运动。

…。我打算在WordPress中为您创建一个比较表,但这不是问题。 完全是我的意思。

无论如何,这是我认为我们可以开始使用来重新获得一些失去的能力的方法:
CSS-可能可以帮助您进行布局,HTML5支持,表格和白标签
功能标志-条件文本,一次写入/多次发布以及提取
HTML —(别再笑了。HTML比Markdown更具功能)表,​​上下文相关的帮助,包括
重复数据删除-智能本地化,包括
Javascript,PHP等-提取和格式化,菜单,导航,面包屑

哇,有很多东西要学。 另一方面,上周我听到了一个演讲,其中包括一份5分钟的清单,列出了您成为一名有用的devop工程师所需的所有“知识”,因此与之相比,这还不错。 对于那些因为喜欢写作而不是因为喜欢技术而从事技术写作的人来说,这是一个非常令人生畏的清单。 并不是说作家不能学习技术-显然我们可以,因为我们学习了那些旧工具。 只是围绕着这种新的文艺复兴时期的著作,才有了社区的开端,没有一个工具可以教给初中生。

我之所以从事技术写作,是因为我和一位非常前卫的教授一起上了英语文学课,他教授了我们手工编码的HTML(因为1995年)。 那是为我打开门的钥匙。 但是现在有什么钥匙?

我希望Corilla能够继续学习,成长和蓬勃发展-他们可以添加许多这些功能或已经拥有这些功能。

我希望Read the Docs获得足够的资金来雇用既是技术作家又是编码员的人员,因为他们缺少一些重要的用例,但它们也是行业标准。

我希望OpenAPI标准和Swagger使得将代码片段的强大功能扩展到非API文档中变得更加可能和容易,因为它们以一种新的方式解决了这个问题,并且涉及许多我正在寻找的超文本性。

我希望Confluence意识到他们会设置人员来创建无法使用的Wiki,因为他们默认使用的是旧的孤立世界。

老实说,我希望SharePoint自发燃烧,因为那很可怕。