在您真正开始写作之前,请准备一个大纲。大纲将帮助您清晰地了解主题,并让您一次专注于 HOWTO 的一小部分。
除非您的 HOWTO 非常小,否则您的大纲可能是多层次的。在制定多层次大纲时,顶层应包含一般主题领域,子标题应更详细和具体。独立查看大纲的每个级别,并确保它涵盖了主题的所有关键领域。子标题应涵盖它们所属标题下的所有关键领域。
您大纲中的每个项目都应跟随前一个项目,并引导到下一个项目。例如,关于特定程序的 HOWTO 不应在安装之前有关于配置的部分。
您可以选择使用以下大纲来编写关于使用特定程序的 HOWTO
开发历史
从哪里下载软件
如何安装软件
如何配置软件
如何使用软件
您可能会发现在写作过程的这个阶段尝试一下“卡片分类”很有帮助。将所有迷你主题领域写在纸片上。现在将这些纸片分类为主标题及其子部分。在您开始之前洗牌纸片可能会有所帮助。这将有助于在工作时让您耳目一新。
当您对您的大纲感到满意时,请再次以批判的眼光审视它。您是否充分详细地涵盖了每个相关主题?您是否没有超出文档的范围?最好将您的大纲展示给其他人(包括 LDP 讨论列表)以获得一些反馈。请记住:在提纲阶段重组文档比在编写完文档后重组要容易得多。
![]() | 轻松编写 HOWTO |
---|---|
如需编写 HOWTO 大纲方面的帮助,并在文档标记方面抢占先机,请查看LDP HOWTO 生成器。请注意,这是用于生成 HOWTO 的。常见问题解答和指南的模板可在附录 A中找到。 |
![]() | 您不是孤单一人 |
---|---|
您可能已经注意到这里正在形成一个主题。就像自由软件一样,当您“尽早发布,经常发布”时,自由文档是最好的。讨论列表包括许多经验丰富的 LDP 作者,在就您的贡献做出决定时,您明智的做法是征求他们的意见。 |