どのようなオンライン技術文書システムをお勧めしますか?[閉まっている]


11

目標は、次の主要な要件を備えたオンラインドキュメントシステムを用意することです。

  • 主に、すべてのアプリケーションの最終的な技術文書の中間段階として使用されます(ただし、おそらく完了しません)。通常は次のように使用されます。誰かに問題があり、それを修正し、修正をすぐに書き留めます。今起こっているのは管理不能なことです。誰かに問題があり、私はそれを修正します。私も誰かも喜んでいますが、2か月後、他の誰かが同じ問題を抱えています。
  • どこからでもアクセスでき、Apacheサーバーの背後で実行されます
  • ユーザー/グループ管理、読み取り専用/読み取り/書き込み/管理アクセスを許可
  • 形式はそれほど重要ではありません:プレーンテキストでもかまいませんが、wikiスタイルの方がいいでしょう
  • 安いか無料

私のいくつかのアイデア:

  • ファイル共有上またはsshを介してファイルを提供するだけです(短所:Windowsとあまり互換性がない、長所:シンプル、任意のファイルタイプが可能)
  • SCMに保存します(svn / git、上記と同じですが、アクセスとアクセスの制御が簡単です)
  • Confluence:既にJiraを使用していますが、Confluenceには価値がありますか?Jiraとどのように統合されますか?
  • 他に何か?

これらについてコメントすることをorしないでください。他のシステムと経験を共有してください。


ドキュメントはコード(Javadocsなど)から生成されていますか、それともゼロから、ユーザーガイドとして、または2つの組み合わせで作成されていますか?
FrustratedWithFormsDesigner

それは主に、よりユーザーガイドではなく、コードのドキュメントのだ(まあ、我々としても、doxygenで生成、我々はそれを含めるかもしれないことを持っているが、それは関心の最初のポイントではありません)
stijn

私はスポルスキーにいくらかの現金を引き渡します。
ジョブ

回答:


11

ウィキを提案するつもりでした

ConfluenceはWikiであるため、JIRAでConfluenceを使用することは素晴らしいアイデアだと思います。JIRAの問題に直接結び付けられるという利点があります。したがって、実際のコード/ドキュメント/行われた変更などです。

このようなコードドキュメントリポジトリの鍵は、ナビゲーションの側面です。切断されたページ、見つけにくいページなどは望ましくありません。Webサイトの場合と同じように、「サイトレイアウト」を考慮してください。


Confluenceはさまざまなフラット形式でエクスポートできるようです。簡単に編集可能から完成したproduc.tに到達する最も簡単な方法の1つのように聞こえます

2
私が働いているConfluenceがあります-MediaWikiから移行しました-それは多くの形式(Wordが最も人気があります)に出力するのに良い仕事をします。しかし、WYSIWYG編集ツールは信じられないほどバグが多く、タグ付けシステムには、少なくともインストール時に、多くの要望があります。
フィリップレーガン

Wikiの+1の場合、TracはSVNと統合され、ファイル共有も可能になるため、Tracが非常に役立つこともわかりました。

Confluenceトライアルを確認しましたが、これが解決策となります。必要以上のことをできるように思えますが、作業はとても簡単です。数年前にTracを試しましたが、特にプラグインなどに関しては、私の好みには少し面倒すぎました。
stijn
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.