2

現在、Visual Source Safe を使用して技術仕様書を保存しています。

実際のドキュメントは MS word で書かれています。

仕様を単語形式で書くことが大きな負担であることがわかった場合、仕様が真に使用されるためには、使用、さらに重要なことにアクセスに障壁があってはなりません。

ドキュメントをすばやくスキャンしたり、他の依存ドキュメントまたはセクションへのハイパーリンクを取得したりできない場合、これらすべてが何の役に立つのでしょうか?

それを背景として：

本当にアクセス可能なドキュメントを作成するために存在するソフトウェアは何ですか? つまり、他のページ/セクションなどへのハイパーリンクですか? またはクエリ可能で、モジュール 4.5.3 に依存するすべてのドキュメントを表示できます

それは基本的にただのWikiですか？他に何か？

4

4 に答える 4

1

Wiki は、仕様の作成と維持に最適です。しかし、人々の机の上に落としたときに満足のいく「ドスン」という大きな紙の文書を生成することは困難です。

私はワードでやり遂げました。相互参照、インデックス、テーブル、ページネーションなどのすべての自動化を活用する方法を学ぶだけです.

私は仕様を、意思決定者と開発者という 2 つの聴衆を持つものと考えています。Word ドキュメントは、意思決定者向けです。開発者は、後で仕様を実装するときに役立つものを考え出すでしょう。

于 2008-10-27T19:16:48.867 に答える
0

技術文書とメモに Confluence を使い始めたばかりです: http://www.atlassian.com/software/confluence/

これは、すぐに使用できるフル機能のブラウザー ベースの wikiですが、思いのままに微調整することもできます。セキュリティ、リッチ テキスト、ハイパーリンク、添付ファイルなど、プロの wiki に期待されるすべての機能を備えています。また、技術者ではない人 (「C」で始まる 3 文字のタイトル) でさえも使用できるほど直感的です。

Atlassian の Web サイト (上記のリンクを参照) にアクセスすると、オンライン デモを試すことができます。また、コミュニティ サポートを提供するために独自のドッグフードを使用しています。

于 2008-10-28T02:18:07.097 に答える
0

Word はサブドキュメント (他のドキュメントへのリンク) のアイデアをサポートしていると思いますが、VSS がないとうまく機能するかどうかはわかりません。しかし、それは調べるものです。

ただし、Wiki は、ほとんどの場合、探しているものです。

于 2008-10-27T19:15:10.913 に答える
0

Java には javadoc によって生成された API ドキュメントがあり、Python には epydoc などのツールによって生成された API ドキュメントがあります。

どの言語で作業していますか? 自分の言語用の javadoc や epydoc などのツールを探しましたか?

于 2008-10-27T20:02:38.243 に答える