寻找良好的文档格式

时间:2011-09-05 17:10:07

标签: documentation

我有一个非常大的业余爱好项目,我不想迷路,所以我不在课程记录,可能是“设计文档”或“手册”,但我还没有找到一个好的格式,所有我的文档分布在.txt .doc .odt等中,也许你可以帮助我:-)?

最好的格式是:

  • 仅限一个文件(例如,不是html)
  • 轻松添加图像,大/小/粗体/下划线/ ...文本。
  • 使用简单(无需'编译',无需使用气动编辑器/简易编辑)
  • 优先在左侧的可折叠'索引'
  • 可以(很容易)在几台计算机上阅读(PC是必须的,但如果它适用于Mac等,那就太好了。)
  • 免费或不贵(至少是免费且优秀的读者)

我已经尝试过.odt,powerpoint和.pdf,但它们有明显的问题(odt:没有索引,ptt:昂贵且只有PC,pdf:我认为这一切都没有,但是没有(好的)免费编辑器。)

您在撰写文档时使用了什么,并且您对适合我的格式有所了解?

谢谢!

[edit]实际上我发现使用不同标题并导出为pdf的Open Office文本文档会自动生成书签(对于标题,也可以折叠),这就是我搜索的内容。 因为问题只有一个答案就结束了(谢谢!但这不是我想要的)我无法回答我的问题,我只是让它成为......

1 个答案:

答案 0 :(得分:2)

你试过Markdown吗?这就是我编写所有冗长文章的方式,因为Markdown本身非常易读(这就是重点)并且可以通过任何文本编辑器进行编辑。但是使用模板引擎(我使用Jinja2),你可以很好地吐出统一的文本文档组。

如果你想看一些语法的例子,维基百科上有一篇很好的文章:http://en.wikipedia.org/wiki/Markdown#Syntax_examples