2010-01-16 72 views
2

当我尝试在我的博客中记录我的服务器配置步骤时,它看起来没有结构化。我需要一些标准布局指南,面向howtos的东西,标题,步骤,某种wiki支持的文档创建标准,可以强制执行或指导文档布局。寻找符合标准的文档工具

是否有任何这样的文档标准伴随着wiki工具集?

+1

您可能会对serverfault.com上的这类问题产生更多的牵引力,我曾想过。 – 2010-01-16 14:17:35

回答

2

给一个尝试DocBook

+0

我认为这需要一些学习,但它显示了我想要的结构。我认为从长远来看,使用它的原则将会变得很好 – vfclists 2010-01-18 11:33:07

1

我读符合标准的为简单的“组织”,或者,“明显给读者”。考虑通常组织user documentation的典型方式。您通常打算在3个不同的主要使用案例中打开文档:

  1. 该系统是新的,并且您正试图弄清楚发生了什么。 (PDF文件,较长的文章)
  2. 您正在查找您忘记的东西的详细信息。 (指向男性参考信息的索引)
  3. 您需要特定问题的帮助,而且您不完全确定此工具如何帮助您。 (食谱,常见问题)

我可能会尝试复制一个特定的生态系统(Windows,Unix,苹果),基于用户最熟悉的。