仕様とドキュメントを作成するためのWikiのようなツール[終了]


9

ソフトウェアプロジェクトの仕様とドキュメントを作成および管理するためのwikiまたはwikiのようなシステムを探しています。

利用可能なwiki実装がたくさんあることは知っていますが、この種のタスクに特に適しているものはありますか?

実際、それはwikiである必要はなく、仕様とドキュメントを簡単に記述してナビゲートし、変更の追跡をサポートするシステムにすぎません。


1
特別なプラットフォームを使用していますか?たとえば、MicrosoftのTFSは好きですか?
Saeed Neamati、2011

@Saeedの質問の流れに沿って、あなたのチーム/組織は、ナレッジ管理と共有のためにすでにどのようなインフラストラクチャを導入していますか?また、仕様やドキュメントを作成するための現在のプロセスは何ですか?
Thomas Owens

回答:


6

LaTeXとSVNを使用しています。LaTeXドキュメントは単なるテキストファイルであるため、一部のバイナリ形式または部分的にバイナリ形式とは異なり、バージョン管理で問題なく動作します。

あなたがコードでそれを使用することから、あなたが慣れているバージョン管理のすべての利点(そして確かに欠点)を手に入れます。

LaTeXは(独自のスタイル/クラスを定義するために)少しの設定を必要としますが、一度設定すると非常に良いです-プレゼンテーションではなくコンテンツのみに集中することができます(実際にあるように常に調整するのではなく、 WYSIWYG)、それでも最後には洗練されたプロ並みのPDFドキュメントを取得します。


4

個人的には、私はTiddly Wikiが本当に好きです

それはかなり完全なwiki構文を持ち、自己完結型の単一のhtmlファイルであり、サーバーを必要とせずにさまざまなWebブラウザーでうまく機能します。

それはあなたがプラグインを追加することを可能にする拡張可能なプラグインアーキテクチャさえも持っており、ティドルの暗号化や脚注の追加のようなあらゆる種類の興味深いことを行うことができます。


3

Microsoftプラットフォームの場合、SharePointとのTFS(Team Foundation Server)統合はまさにあなたが探しているものです。新しいチームプロジェクトを作成することで、ソフトウェア開発プロセスのほぼすべての側面を網羅するテンプレートを選択できます。これにより、チームメンバーを定義し、そのメンバーの役割とセキュリティ権限を割り当て、プロジェクトに関連するドキュメントと仕様をアップロード、共有、編集し、その他多くのすばらしいことを行うことができるポータルが提供されます。

他のプラットフォームでは、GitHubのようなものを使用できると思います(ただし、それについてはよくわかりません)。



0

選択したソース管理管理インフラストラクチャにドキュメントをチェックインして、Sphinxを試してみてください。これには、ソース管理の利点と、比較的軽量のマークアップ言語であるreStructuredTextがあり、習得が容易で、変換(HTMLからPDFなどへの変換)に非常に適しています。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.