web-dev-qa-db-ja.com

プロジェクトのドキュメント、仕様を整理および維持するためのソフトウェア？

プロジェクトの内部ドキュメント、仕様、要件などを整理および維持するためのソフトウェアを探しています。現在、すべてのドキュメントを大量のMS Wordとして保存していますDOCファイルがソース管理リポジトリに保存されているため、バージョン管理、それはいいことですが、この情報を検索したり、それらの間にリンクを作成したり、分類したり、協力したりすることはできません。

要件、設定：

  • クライアント側のゼロインストール（WEBベース）。
  • ドキュメントのバージョン管理。
  • ドキュメントの注釈。
  • ドキュメントのリンク。
  • 完全検索（すべてのドキュメント）。
  • MS Word（* .doc）import\export。
  • WYSIWYGテキストエディタ。

これまでに発見して試したシステム：

project-managementdocumentationknowledge-managementknowledge-base
15
Alex Burtsev

Sphinx のようなものはどうですか？

ドキュメントをreStructuredText（Stack Overflowが使用するMarkdownと同様）でプレーンテキストファイル（=バージョン管理が簡単）に記述し、SphinxがHTMLページを出力します。

（私が知っている）2人の最も著名なSphinxユーザーは Python言語 と TortoiseHG です（Sphinxで生成されたドキュメントのリンクを参照してください）。

編集：

エンドユーザー向けのドキュメントではなく、プロジェクト内部のドキュメントについて話していると読みました。
私の意見では、Sphinxのようなものが内部のドキュメントにも最適な方法です（ただし、アナリストにreStructuredTextを記述させることができる場合）。

  1. ドキュメントのバージョン管理を簡単に行うことができます（テキストファイルのdiffは、.docや.pdfなどのバイナリファイルよりもはるかにスペースが少なくて済みます）。
  2. 開発者が読みやすい.docまたは.pdfファイルを必要とする場合は、ソースからSphinxを使用して作成できます。

Sphinxが複雑すぎる場合は、さらに簡単な方法があります。Markdownでドキュメントを記述し、 Pandoc を使用して（たとえば）.rtf、.docまたは.pdfファイルを作成できます（より多くの）。
PandocはSphinxよりも使い始めるのが簡単であることがわかりましたが、PandocはSphinxなどのニースメニュー階層を作成できません（Pythonおよび上記でリンクしたTortoiseHGのドキュメントのように）。

使用するツールに関係なく、内部Webサーバーとビルドサーバーがある場合、誰かがドキュメントに何かをプッシュするたびにビルドサーバーがHTML出力を生成し、これをWebサーバーにコピーするように設定できます。そのため、アナリストは最終的な出力について考える必要すらありません。変更をコミットしてプッシュする必要があるだけです。

6
Christian Specht

まあ、あなたはWikiを実装しようとすることができます。 Mediawikiには、あなたが話している不足しているすべての機能（検索機能、バージョン管理の履歴、リンク、分類）があります。どのバージョンのドキュメントがどのバージョンのソフトウェアに属しているかを正確に把握する必要がありますが、これは、バージョン参照または特定のカテゴリを各バージョンに依存する記事に含めるという慣例により行うことができます。

しかし、あなたはあなたが開発者ではない「アナリスト」を持っていると書いています（私は認めます、私はその星座のファンではありません）。これらの種類の人々は、MS OfficeツールをWikiのようなテキスト指向のツールに置き換えると、満足できないことがよくあります。また、MS-Wordはフリーソフトウェアではないので、「フリーソフトウェア」という要件は必須ではないと思います。この状況では、Sharepointサーバーの方が適している可能性があります。無料ではありませんが、AFAIKには要求されているすべての機能があり、Word、Excelなどを使用してドキュメントを作成できます。

5
Doc Brown

最近、多くの興味深いプロパティを持つ Alfresco DMSの使用を開始しました。

  • 非常に簡単なインストール
  • 大量のドキュメントをすばやく検索するための組み込みのインデクサーがあります
  • ワークフロー、グループ、および必要に応じて、顧客によるドキュメントへの特定のアクセスを許可します
  • オープンソース
  • アクティブなコミュニティ
  • LDAP/AD/SSO統合
  • 多くの異なるドキュメントを処理します

また、いくつかの欠点もあります。

  • ユーザーインターフェイスは常に直感的ではない
  • これは実際にはWikiではないため、1つのドキュメントで同時に共同作業を行うと、少し脆弱になる可能性があります

振り回す場合はご意見をお寄せください。

2
Dibbeke

学習曲線は少し急になりますが、最大のレバレッジが得られるため、仕様とドキュメントをバージョン管理下に置くことを常にお勧めします。ナレッジエンジンの場合、以下をお勧めします

  1. Trac -使いやすいバグ追跡システムとナレッジエンジン。 Python=で記述されており、拡張可能です。数分で稼働します。
  2. MoinMoin -本格的なwikiエンジン。再びPython多くの機能を備えた

どちらも最小限のインターフェースを備え、ほとんどのWiki構造をサポートし、導入と保守がかなり簡単で、改訂をサポートし、優れたWYSIWYGエディターを備えており、ドキュメントや仕様も保持できます。プロジェクトが本当に巨大でない限り、上記のいずれかを選択できます。

2
Ubermensch

別の可能性は、ドキュメントに LaTeX または他のテキストフォーマッタ（おそらくtexinfoまたは lout ）を使用することです。その一部は機械で生成できます。 LaTeXをHTMLに変換する HeVeA のようなHTML変換用のツールがいくつかあります。 doxygen を使用して、ソースコード内の構造化コメントからドキュメントを生成することもできます。また、ドキュメントの手書き部分は、ソースコード（たとえば、w.r.t。バージョン管理とビルド）として管理できます（また、そうする必要があります）。

0
Basile Starynkevitch