2

目前我正在使用 Visual Source Safe(是的,是的!)来存储我的技术规范文档。

实际的文档是用 MS Word 编写的。

如果发现以 word 格式编写规范是一个很大的负担,那么要真正使用规范,就不应该有任何使用障碍,更重要的是访问

如果我不能快速扫描文档、超链接到其他相关文档或部分,那么这一切有什么用?

因此,以此为背景:

有什么软件可以创建真正可访问的文档?即到其他页面/部分等的超链接?甚至可查询,因此我可以查看依赖于模块 4.5.3 的所有文档

它基本上只是一个维基吗?还要别的吗?

4

4 回答 4

1

Wiki 非常适合创建和维护规范。但是,很难生成一个大的纸质文档,当您将它放在人们的办公桌上时会发出令人满意的“砰砰”声。

我已经用 Word 了。只要学会利用它在交叉引用、索引、表格、分页等方面的所有自动化。

我认为规范有两个受众:决策者和开发者。Word 文档是为决策者准备的。开发人员稍后会在实施规范时提出一些有用的东西。

于 2008-10-27T19:16:48.867 回答
0

Java 有由 javadoc 生成的 API 文档,Python 有由 epydoc 等工具生成的 API 文档。

你用什么语言工作?您是否为您的语言寻找过 javadoc 或 epydoc 之类的工具?

于 2008-10-27T20:02:38.243 回答
0

我们刚刚开始将 Confluence 用于技术文档和注释: http: //www.atlassian.com/software/confluence/

这是一个功能齐全的基于浏览器的 wiki,开箱即用,尽管您可以根据自己的喜好对其进行调整它具有您对专业 wiki 的所有期望,包括安全性、富文本、超链接和附件;它足够直观,即使是我们的非技术人员(以“C”开头的 3 个字母标题)也使用它。

如果您访问 Atlassian 的网站(请参阅上面的链接),您可以玩他们的在线演示......他们吃自己的狗粮来提供社区支持。

于 2008-10-28T02:18:07.097 回答
0

我相信 Word 支持子文档(指向其他文档的链接)的想法,但是我不确定没有 VSS 的情况如何,更不用说使用 VSS。但这是需要调查的。

然而,wiki 几乎就是您要寻找的东西。

于 2008-10-27T19:15:10.913 回答