四时宝库

程序员的知识宝库

让 HTML 和 PDF 手册分发自动化

一直以来, HTML/PDF 的准备与产品开发进程相对滞后。而现代 Agile 敏捷开发要求,所有交付物,包括软件,产品手册一起交付。如何做到?本文与您分享有关缩短手册交付周期的诀窍。

准备

  1. 结构化文档或格式的 MS Word 文档
  2. Oxygen Author 编辑器
  3. GIT 仓库,如 GITEE, GITLAB, GITHUB
  4. HTML ,PDF 发布脚本
  5. 北京镭内容平台的命令行 API

方法

当前方法:桌面排版整个文档,邮件、即时通讯提交审核 > 多次变更(内容、格式),手册设计冻结 > 文档工程师将最新版手册邮件或者即时通讯或者编译打包后交付客户(用户)

改变后方法:Topic 初稿,Git 协同平台 > 多次变更(内容),手册设计冻结 > 文档工程师不需要人工交付可以自动将最新版手册交付客户(用户)实际工作效果

好处

每次您提交了更新到 GIT 仓库,基于上面的工具链条,您的 HTML/PDF 手册会被自动发布和上线,缩短了手册交付与产品交付的差距达 40% 以上的时间,提高了交付速度。

发表评论:

控制面板
您好,欢迎到访网站!
  查看权限
网站分类
最新留言
    友情链接