2008/05/21

@ITのドキュメント作成技法という記事が参考になります


ツールを使ったドキュメント作成技法(前編) - @IT

この記事は、いかに価値あるドキュメントを効率的に作成するかに主眼を置いて、どのようにドキュメントを作成するか解説しています。

システム開発工程ごとのドキュメント一覧や、アジャイル・ドキュメントという考え方、ドキュメント作成時に意識することなど参考になることが多いです。

あと、ソースコードのコメントからAPIリファレンスを作成する NDoc というツールがありますが、Visual Studio 2005 以降は Sandcastle というツールが一般的になっているようです。これは知らなかったです。

NAnt と Sandcastle を連携させることはできるようですね。ふむふむ。

記事では、Sandcastle の使い方も紹介されています。

 


スポンサーリンク


このエントリーをはてなブックマークに追加




Twitter ではブログにはない、いろんな情報を発信しています。


コメント

NDocは.NET 2.0に対応する前に完全に更新が止まってしまっているようですね(最新版の1.3.1が2005年1月リリース)。以前愛用していただけに残念。

>>dara-jさん

おぉ。そうだったんですね。私は、.NET 1.1の頃はよく開発をしていたのですが、しばらく.NETから離れていたので知りませんでした。。。

情報ありがとうございます!

本当にいろいろなツールが便利になっていますね。
私は、HotDocumentをいつも使っています。
http://www.hotdocument.net/

何かの参考に。

>>れんたさん

コメントありがとうございます。
HotDocumentでも.NETのドキュメント生成ができたんですね。知りませんでした。

コメントを書く



プロフィール

  • 名前:fnya
    経歴:
    SE としての経験は15年以上。様々な言語と環境で業務系システム開発を行い、セキュリティ対策などもしていました。現在は趣味SE。

    Twitter では、ブログでは取り上げない情報も公開しています。


    ブログについて

    このブログは、IT、スマートフォン、タブレット、システム開発などに関するさまざまな話題を取り上げたり、雑感などをつづっています。


    >>ブログ詳細
    >>自作ツール
    >>運営サイト
    >>Windows 10 まとめ

    Twitter のフォローはこちらから Facebook ページはこちら Google+ページはこちら RSSフィードのご登録はこちらから