2010-11-27 10 views
3

オープンソースプロジェクトを完了した後、人々にコードの使い方を理解させるために、充実したドキュメンテーションWebサイトが必要です。私がつまずいている良いドキュメンテーションのオープンソースプロジェクトのための素晴らしいドキュメントを作成するにはどうすればよいですか?

例:

http://guides.rubyonrails.org/

http://vowsjs.org/

http://codeigniter.com/user_guide/

http://expressjs.com/

私が前にウェブ上のドキュメントの任意の種類を作成したことがないとtのいくつかの提案を聞きたい上記のようなきれいな文書として簡単に作成するために使用するools。

また、Drupalを使用してドキュメントを作成する人はいますか? pdocがあります

+0

誰かが「ではない本当の問題」としてこれを閉じるために投票しました。私はそれが本当の質問だと思うが、それは重複している。また、「Solid documentation website」という質問のタイトルは、何が尋ねられているかを示すものではありません。このトピックに関する実際のQ&Aについては、http://stackoverflow.com/search?q=generate+documentationを参照してください。特に、http://stackoverflow.com/questions/2001899/creating-great-api-documentation-tools-and - 技術。また、あなたは誰がその文書を消費するのか、それが何をカバーするのかを言わない。 APIドキュメント、デベロッパーツールのドキュメント、ITプロのドキュメントなどですか? – Cheeso

+0

[偉大なAPIドキュメントの作成:ツールとテクニック]の複製が可能です(http://stackoverflow.com/questions/2001899/creating-great-api-documentation-tools-and-techniques) – Cheeso

+0

@cheeso:消費するユーザードキュメントは、私が例として提供したリンクされたドキュメントを消費する人に似ています。 – ajsie

答えて

関連する問題