如果您有兴趣编写或维护 HOWTO 文档,请首先通过 feedback@en.tldp.org 联系我们。如果您想维护一份无人维护的 HOWTO 文档,请尝试联系之前的作者。
请查阅 LDP 作者指南 以获取关于编写和提交 HOWTO 文档的详细信息。
以下是您在编写 HOWTO 文档时应遵循的一些通用指南
尽量使用有意义的结构和组织,并清晰地写作。请记住,许多阅读 HOWTO 文档的人的母语不是英语。
确保所有信息都是正确的。这一点我们再怎么强调也不为过。当您不确定时,可以推测,但要明确说明您只是猜测。
确保您涵盖的是最新版本的可用软件。此外,请务必包含关于从何处下载软件的完整说明(FTP 站点名称,完整路径名),以及软件的当前版本号和发布日期。
如果合适,在末尾包含一个 FAQ 部分。许多 HOWTO 文档都需要一个“FAQ”或“常见问题”部分,以涵盖无法在正文中涵盖的信息。
HOWTO 文档应该以 DocBook 或 linuxdoc SGML;或 DocBook XML 格式提交给我们。请参阅 LDP 作者指南 以获取更多信息。
使用其他 HOWTO 文档作为模型。HOWTO 文档的 SGML/XML 源代码可在 Linux FTP 站点上找到。此外,请查看 LDP 作者指南、LDP 宣言(和许可指南)以及 LDP 站点的 作者资源区。
确保您的姓名、电子邮件地址、日期和版本号位于文档的开头附近。如果需要,您还可以包括 WWW 地址和邮寄地址。标准标题是:标题 / 作者姓名和电子邮件地址 / 版本号和日期。例如
LDP 示例 HOWTO 文档,作者:various_authors,版本 6.1,2001-05-01
请参阅 LDP 作者指南 以获取更多信息。
最后,请准备好接收关于您写作的问题和评论。每天来自世界各地对 HOWTO 文档集合有数百次访问。
在您编写完 HOWTO 文档后,请将 SGML 源代码通过邮件发送至 submit@en.tldp.org。
当提交 HOWTO 文档时,务必通过我们,因为我们维护着文档归档,并且需要跟踪正在编写哪些 HOWTO 文档以及谁在做什么。
请在适当的时候向 LDP 发送定期更新。