当您在制定大纲时,您很可能会研究您的主题——尤其要确认您即将撰写的文档尚不存在! 这里有一些提示,可以避免您之后为此感到头疼
在您研究时整理您的资源。几乎可以肯定的是,当您最需要关键信息时,您将不记得在哪里可以找到它。 这将有助于您在进行研究时将重要(甚至不太重要)的页面添加书签。 确保书签的标题反映了页面对您的重要性。 如果一个页面中有多个关键想法,您可能希望使用不同的标题为同一页面添加书签。
假设您最重要的资源会消失。可怕的 “Error 404: 页面未找到”。 即使您已为页面添加书签,当您返回时,它也可能不在那里。 如果页面包含非常关键的信息:请制作副本。 您可以通过创建一个文本文件来做到这一点,其中包含文档的标题、作者姓名、页面的 URL 以及页面的文本,并将其保存到您计算机上的文本文件中。 您也可以选择 “打印” 文件为 PDF 格式(如果使用智能浏览器,另存为或转换为 PDF 格式将捕获页面上的原始 URL)。
立即开始创建您的 “资源” 页面。当您找到感兴趣的页面时,将其添加到资源文档中。 您可以通过导出书签或维护一个单独的文本文件来完成此操作,其中资源按子类别排序。 现在付出一点努力将在以后为您节省大量时间。
有关 DocBook 书目标记的更多信息,请参见 第 D.7 节。
在您进行时写下主题领域。如果您正在进行卡片分类,您可能会发现编写主题卡片特别有用,当您找到涵盖该特定主题的页面时。 在卡片的顶部写下主题领域。 在卡片的主要区域写下一些关于您可能在该主题下涵盖的内容的注释——包括包含重要信息的页面的标题。 如果一个子主题变得太大,您可能需要将其分成多张卡片。
将通用信息与版本特定信息分开。您描述的软件的新版本可能会在您发布文档后的第二天发布。 其他事情,例如在哪里下载软件,不会改变。 或者,您可以选择记录特定软件的旧问题,以此鼓励读者升级到可用的最新版本:“已知软件 X 版本存在特定错误。 该错误已在 Y 版本中修复。”
保存所有相关的电子邮件。人们通常会对您正在撰写的问题有有趣的见解。 任何关于您主题的问题都应在最终文档中得到解答。 如果您正在编写关于软件的内容,请务必询问人们他们正在使用什么系统。 在您的文档中添加关于您的说明已在哪些系统配置上测试过的信息。 (有很多具有适度不同配置的朋友可能非常有益!)所有这些个人经验都可以极大地丰富您的最终文档。