プロジェクトのドキュメント、仕様を整理および管理するソフトウェアですか?[閉まっている]


15

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

要件、設定:

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

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


どんなプロジェクト文書がありますか(テキスト、グラフィカル、UMLダイアグラム、タイムスケジュール、テキスト仕様、ユーザーストーリーなど)。維持する必要がある人は何人ですか?ソースコードの特定のバージョン/リビジョンと同期している必要がありますか?
Doc Brown

@ DocBrown、95%のテキスト、3〜5人が作成します。ソフトウェア製品のバージョンとは同期していませんが、ソースコードのリビジョンとは同期していません。
アレックスバーツエフ

XWikiは無料の素晴らしいソリューションのように見え、MS Officeとうまく統合します。
アレックスBurtsev

1
これは、技術文書を書くためにどのプログラムを使用していますか?そして答えの多くは似ていますが、そのようなドキュメントのためにウィキを使用することに対してより良い議論があります。
マークブース

PHPKBのようなナレッジマネジメントソフトウェアはどうですか?それは無料ではありませんが、あなたの目的を非常にうまく果たしているようです。
アニルードスリバスタヴァ

回答:


6

スフィンクスのようなものはどうですか?

reStructuredText(構文はStackdownflowが使用するMarkdownに似ています)のドキュメントをプレーンテキストファイル(=バージョン管理が簡単)に記述し、SphinxがHTMLページを出力します。

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


編集:

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

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

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

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


HTMLを生成するだけのように見えるので、Webサーバーで公開する必要があります
Alex Burtsev

1
@AlexBurtsev:公開したいなら、はい。一方、今ではWord .docファイルを使用しているので、公開したい場合はWebサーバーにも配置する必要があります。
クリスチャンスペクト

Sphinxには「PDFへの出力」パスがあることに注意してください。
ロバートハーベイ

@ ChristianSpecht、Wiki、Wordpressには、Word Docファイルをインポートするプラグインがあります。
アレックスBurtsev

@AlexBurtsev:ドキュメントで何をしたいのか理解できたかどうかわかりません。Webに配置する場合は、Sphinx、Wordpress、.docダウンロードなどを使用する場合でも、何らかのWebサーバーが必要です。シュリンクラップソフトウェアでドキュメントを配布する必要がある場合は、Sphinxを使用してPDFまたはWindowsヘルプファイルを生成できます。
クリスチャンスペクト

5

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

しかし、あなたは開発者ではない「アナリスト」がいると書いています(私は認めますが、私はその星座のファンではありません)。この種の人々は、MS OfficeツールをWikiのようなテキスト指向のツールに置き換えると、しばしば不満を抱きます。また、MS-Wordはフリーソフトウェアではないため、「フリーソフトウェア」の要件は必須ではないと思います。この状況では、Sharepointサーバーがより良い代替手段になる可能性があります。無料ではありませんが、知る限り、リクエストしているすべての機能があり、Word、Excelなどを使用してドキュメントを作成できます。


1
既にSharePointサーバーを持っていますが、開発者はそれを好みませんし、使用したくありません(私は開発者です)。必要な情報を簡単に見つけられるものが必要です。分類およびリンクされた情報。
アレックスBurtsev

@AlexBurtsev:Sharepointサーバーを自分で使用したことはありませんが、Sharepointがあなたが説明した機能をすべて提供していると感じていました。ただし、Wikiを好む場合は、Mediawikiが適しています。ただし、最初にインストールして、構造のアウトラインを定義し、使用方法/使用しない規則を定義します。
Doc Brown

私は現在、MS Officeとの統合のためのXWikiをしようとしている
アレックスBurtsev

@DocBrown-SharePointは恐ろしいです。それは直感的ではなく、タブとサブタブの完全な迷路であり、適切なバージョン管理を維持しません。これを使用する場合は、すべてのドキュメントを内部サーバーの共有ディレクトリにダンプする方が良いでしょう。ウィキは通常、この種のことを行う方法です。
多項式

2

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

  1. Trac使いやすいバグ追跡システムとナレッジエンジン。Pythonで書かれており、拡張可能で、数分で稼働します。
  2. モインモイン本格的なwikiエンジン。繰り返しますが、多くの機能を備えたPython

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


2

最近、Alfrescoの使用を開始しました、多くの興味深い特性を持つ DMSの。

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

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

  • ユーザーインターフェイスは常に直感的ではありません
  • それは実際にはウィキではないので、1つのドキュメントの同時共同作業は少し壊れやすいかもしれません

あなたがそれにスイングを与えることにした場合、あなたの意見で私に連絡してください。


0

別の可能性は、使用するかもしれない乳液またはいくつかの他のテキストフォーマッタ(おそらくtexinfoのかさえLOUTを文書化するために)。その一部は機械で生成できます。LaTeXをHTMLに変換するHeVeAなど、HTML変換用のツールがいくつかあります。doxygenを使用して、ソースコード内の構造化コメントからドキュメントを生成することもできます。また、ドキュメントの手書き部分は、ソースコード(バージョン管理とビルドなど)として管理できます(また、そうすべきです)。


ソフトウェア製品のドキュメント(ヘルプ、マニュアル)について話しているのではありません。ソフトウェア仕様、ビジネス要件について話している。
アレックスBurtsev

LaTeXでソフトウェア仕様または技術文書を作成できます。一部のサークルでは一般的な慣例です。
バジルスタリンケビッチ

2
LaTextはどういうわけか* NIXを思い出させ、私たちのアナリストはそのようなOSを群れたことはありません-)、彼らはWindowsの世界に住んでおり、テキスト入力に関してWordよりも難しいことに同意しません。
アレックスBurtsev

-2

文書に加えて、UMLおよびERDツールを使用することをお勧めします。また、これらのドキュメントはZOHOの次の場所に保存できます。 ZOHO-Docsに、これは無料ではありませんが、非常に安価であり、ドキュメント検索機能を使用できます。

最終的に使用するツールが何であれ、テキスト検索を使用して意味のある結果を得るには、ドキュメントの内容を慎重に整理する必要があります。文書コンテンツの編成と巧妙で標準的なファイル命名が非常に役立ちます。

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