第 1 部分

我们持续优化 Merlin Project,使其操作更为简便。我们在不久前就已开始改进启动对话框,并整理检测器。
在版本 8 中,动态帮助 现已加入:只需点击 ? 符号,当您用鼠标(在 iPad 上用手指)指向任意对象时,便会显示相应的帮助说明文字。对于您自定义的字段,您甚至可以 创建自己的帮助文字。
然而遗憾的是,我们的手册稍有滞后。但请放心,我们提供了丰富且最新的文档,例如:
目前尚不存在一本完整的手册。而这正是我现在想要改变的。
该项目
我最近开始重写手册并着手创建这份参考资料。我当然为此设立了一个项目,只是它不得不与我所有其他项目共享有限的时间。
目标
除了显而易见的目标,即用 主要语言 为 Merlin Project 的各项功能创建一份最新文档之外,我还为自己设定了几个子目标或分目标:
- 手册必须以 HTML、PDF 和电子书形式提供。
- 必须可选支持按需印刷。
- 手册应适用于我们的所有产品,即:
- 应在我们的网站、iTunes Book-Store 及其他网站上免费提供。
不过尽管做了种种规划,目标日期仍完全开放,因为我每周的工作负荷各不相同。因此设定一个固定日期作为目标完全不现实。
工具
在 ProjectWizards,我们所有文本都以 Ascii 格式编写,并最迟在每天结束时签入我们的 Git。
与当前流行趋势完全相反,我们并不使用 Markdown 或其某个衍生及扩展版本来写作。我们很久以前就专注于 AsciiDoc,并在数年前转向全新的 Asciidoctor,即 Dan Allen(通过 Twitter)所做的重新实现。做出这一决定的原因主要包括:
- 变量,
- 链接其他文件,
- 条件文本与格式,
- 表格、图表以及许多其他内容,
- 将文本输出为多种不同格式,
- 自动生成目录、术语表、索引和参考书目,
- 以及更多……
差点忘了,当然,BBEdit 在我这里 仍然 是 #1 编辑器。
Asci
iDoc 与 Asciidoctor 的对比
简而言之,您把 AsciiDoc 源文本交给 Asciidoctor,便得到可供发布的结果。也就是说:
- AsciiDoc 是语言
- Asciidoctor 是处理器
与 Markdown 一样,AsciiDoc 作为一种语言被开发出来,旨在低调而简练,简化写作,甚至让写作更为愉快。但 AsciiDoc 本身并非发布格式。它更像是一种速记。这时 AsciiDoc 处理器便登场了。
像 Asciidoctor 这样的 AsciiDoc 处理器会读取 AsciiDoc 源文本,并将其转换为可发布格式,如 HTML 5、电子书或 PDF。当然,整个过程还会借助层叠样式表(CSS)等设计手段加以完善。
Working out Loud (WOL)
本着 Working out Loud 的精神,我会尝试定期汇报这项工作。我的重点不会放在自己一周能写多少字句上,而更多是介绍关于 AsciiDoc 和 Asciidoctor 的帮助以及新的心得。
通过这种方式,我当然也向 Dan Allen 不懈的工作致敬,并愿意给予支持。同样重要的是,这也是对 AsciiDoc 在项目管理中应用的一次肯定。
下周五我们将在此开始。
If you have any questions about this blog article or would like to discuss it, we look forward to your contribution in our forum.