良いドキュメント・マニュアル・仕様書を書くスレ

良いドキュメント・マ ..

520:デフォルトの名無しさん
08/02/12 23:44:47
>>519
大丈夫だ。どうせ誰も見ない。

ぐらいの気持ちで書いてまつ。
本当に皆が必要な内容ならそんな悩まなくても書けるよ。

521:デフォルトの名無しさん
08/02/13 01:27:10
「～したら期待したとおりにうごかねーぞｺﾞﾙｧ」ときた時に
「ドキュメントは読みましたか？ﾌﾌﾝ」とするために書く。

522:デフォルトの名無しさん
08/02/13 23:08:46
ソースコードにドキュメント付けするときには、
とりあえず日付を真っ先に書くようにしている。

ほかの文章は後からでも書けるけど、
こればっかりは後から思い出そうとしても思い出せない。

523:デフォルトの名無しさん
08/02/15 15:13:16
書いてすぐコミットしようよ・・・

524:デフォルトの名無しさん
08/02/16 12:59:06
>>522
ついでに天気とその日の主な事件も書いとけ

525:デフォルトの名無しさん
08/02/26 20:56:32
source code に含まれないドキュメントに数学記号使った数式を
書いたら怒られたんだが, なぜ?

526:デフォルトの名無しさん
08/02/26 23:47:14
>>525
理由も聞かなかったのか？馬鹿

527:デフォルトの名無しさん
08/02/27 00:17:20
>>526 意味がわからんとゆわれた

528:デフォルトの名無しさん
08/02/27 00:26:10
プログラマなら常識ですと言ってやりたいなｗｗｗｗ

529:デフォルトの名無しさん
08/02/27 00:26:46
>>527の意味もわからんわ馬鹿

530:デフォルトの名無しさん
08/02/27 15:40:49
>>437
俺も重複を避ける為にそう思った。
が、この文法では、@param属性(入力,出力、入出力)が付けられない。これは痛い。
従って、@paramを使わざるをえなかった。

//445
ダメだよ、それじゃ。パッと見でもおかしいし、実際変な表示になるよ。

531:デフォルトの名無しさん
08/03/05 23:50:08
マニュアル・手順書を作るのに、使うのはWord？Excel？

俺はExcel派。
Word使うヤツの気が知れない。

要するに、あとで文章直すときに改行がExcelだと
大変だってだけの話でしょ？

レイアウトは断然Excel優位だよね。

532:デフォルトの名無しさん
08/03/05 23:52:51
まだEXCEL使い奴いるんだな

533:デフォルトの名無しさん
08/03/06 09:04:30
つられませんから。

でもスタイル指定しないWordはひょっとしたら
確かにExcelよりクソかもしれない。

534:デフォルトの名無しさん
08/03/06 16:21:43
まあ、Excelの方が向いてるドキュメントはあるわな。

535:デフォルトの名無しさん
08/03/07 01:26:50
>>531
> マニュアル・手順書
にかぎるんだったら, エディタで書いた平テキスト
エンドユーザー向けのマニュアルは別部門が作る
図面ほしいって言われたら、CAD 図面

# 新規ハード使う組み込み系の仕事がほとんどだが

536:デフォルトの名無しさん
08/03/12 18:34:18
ここはdoxygenスレじゃない事は分かっているのですが・・・ちょっと質問。

関数仕様書を作るのにdoxygenを使おうとしています。 ver1.5.5を使っている
のですが、HTML出力は上手くいくものの、rtf出力になるとUTF-8でエンコード
されていて、テキストエディタでは日本語が読めるのですが、Wordやワードパッド
では文字化けして読めません。これではRTF出力する意味がありません。

DoxyWizardでは出力、入力ともShift-JISに設定しているのですが・・・(当然、
ソースのコメントはShift-JISです)

一体何がいけないのでしょうか？

537:デフォルトの名無しさん
08/03/12 21:54:59
SHIFT-JIS
↓
SHIFT_JIS

538:536
08/03/13 09:27:00
SHIFT_JISにはなっていました。エンコード設定の所にカーソル合わせると
「gnuのlibiconv使ってるからそこのページ見ろや」みたいな表示が出るので
そこを見てコピペしたからだと思います。

HTMLはちゃんと表示出来るのにRTFがダメなのが良く分かりません。

539:デフォルトの名無しさん
08/03/13 13:50:29
CP932は試した？

540:536
08/03/14 18:08:47
CP932でもダメのようです。
どうも、エンコード方式を指定するバージョンでは全てダメのようで。
具体的には1.5.2からはダメ。

仕方ないので1.5.1以前を使おうかと思います。ソースいじってなんとかする
スキルはないし。

あと、ついでにもう気づいた事。@paramコマンドで[in][out]表示が出来ますが、
HTMLでは問題ないものの、RTFでは何故か表示できません。

なぜRTFにこだわるかと言うと、提出物としてはHTMLよりもWord文書の方が良い
のではないかという事です。RTFならそのままwordで読めるし、DOCに直すにしても
ほとんど手直しの必要がないですからね。

まぁ、Word出力するなら商用ツール使えって事なのかなぁ・・・でも、ウチの会社
そんなに余裕ないし。

541:デフォルトの名無しさん
08/03/14 20:30:26
defaultcharsetと合ってないor設定されていないんじゃないかな

542:デフォルトの名無しさん
08/03/24 11:25:04
>>536
うちじゃどうしても日本語が必要なときはTeXで出して、pdfに落として提出した。
そうでないときは、全部英語にしておいた。
そうか、1.5.1ならRTFに日本語を出せたのか……

543:デフォルトの名無しさん
08/04/07 23:38:23
ソースにdoxygenのコメントのテンプレートを挿入してくれるツールって無いですか？
たとえば

int f(int x)
{
…
}

というソースがあったら

/*!
*
* @param x
* @return
*/
int func(int x)
{
…
}

のような感じでコメントを挿入してくれるとありがたいです。

544:デフォルトの名無しさん
08/04/12 21:56:16
>>543
よし、売ろう

545:デフォルトの名無しさん
08/04/13 16:41:20
>>543
Visual Studioでの開発ならマクロ組めば出来るんじゃないかな

546:デフォルトの名無しさん
08/04/28 19:31:50
ネットワークプロトコル説明するのに、状態遷移図書いて提出したら
「意味がわからん！！！書き直してこい！！！」
と言われてしまったんだが、おまえらどうやって説明してますか？

# 一応、説明文は遷移図一枚につき5ページくらいは書いたんだが…

547:デフォルトの名無しさん
08/04/28 19:34:27
>>546
＞# 一応、説明文は遷移図一枚につき5ページくらいは書いたんだが…
説明文をだらだらと長く書きすぎたんじゃない？

548:デフォルトの名無しさん
08/04/28 19:42:13
だったら図だけで分かってほしかったよorz

これじゃわからんって言うから、書き足していったらこうなった

どう説明すりゃいいんだ？
縦線ひいて斜め矢印か？
例外だらけになるやないか！！！

549:デフォルトの名無しさん
08/04/28 19:46:17
>>548
怒られたのに何がダメだったのか聞いてはないの？

550:デフォルトの名無しさん
08/04/28 19:50:19
>>548
箇条書きにした？

551:デフォルトの名無しさん
08/04/28 19:51:26
>>549
もっと詳しく書けっていったから詳しく書いたんだが、ついでに数式まで交えて…
「例をだせや！！！」っても、「はじめてなんでありません」と…

552:デフォルトの名無しさん
08/04/28 19:52:27
>>545
そういえば、VSってソース解析する上にマクロからアクセスできるんだったな。
ドキュメント自動生成マクロなんかあってもよさそうなのにな。
何とか工房がそうなのか？

553:デフォルトの名無しさん
08/04/28 20:10:39
>>551
相手が理解できない点を、推測じゃなくて、ちゃんとヒアリングするのは無理なのか?
あと、説明するときは、いきなり本物じゃなくて、ミニマムセットで理解できるかどうか確認するとか。
そこらへんにギャップがあると、「それじゃわからん」vs「ではどう書けと」の対決になるような希ガス。

554:デフォルトの名無しさん
08/04/28 21:32:33
プロトコルなんだから、シーケンス図？（自分対相手でメッセージを線で表現した奴）も
必要なんじゃない？

555:デフォルトの名無しさん
08/04/28 22:06:01
自分<-- メッセージ -->相手

こうかｗ

556:デフォルトの名無しさん
08/04/28 23:24:10
通信プロトコルならシーケンス図がいいんじゃないか？
状態遷移図と突き合わせできるように書けばOK

557:デフォルトの名無しさん
08/04/28 23:33:37
>>556
しかし、シーケンス図だと条件分岐がすごく書きにくくない?

558:デフォルトの名無しさん
08/04/29 01:20:36
パターン別に何種類か書いたらよかろうが

559:デフォルトの名無しさん
08/04/29 01:28:42
組み合わせ爆発しなきゃそれでいいかもしれんが……。

560:デフォルトの名無しさん
08/04/29 12:28:52
プロトコルってのは「やりとりの規約」だかんな
やりとりに出てくるもの全てを図に入れて，なおかつどんなやり取りが行われるのかを書かないといけないんでないかい？
でもヒアリング一発ですみそう

561:デフォルトの名無しさん
08/04/29 12:46:13
rfcでも参考にして書けばいいんでない？

562:546
08/04/29 14:38:51
>>561
RFC を参考にしてではなく RFC 提出できるくらいまじめに書いた

だけど、定義してるのはプロトコルなんで
「実装する奴が理解でない！！！」

結局, フローチャート書きまくりだとか数式無しだとかじゃないと
駄目らしい

だけどさ、状態遷移図をコーディングレベルに落すのは
「あんたらの仕事じゃねぇの？？？」 >>25才位のクライアントの担当者

# つか、ステートマシンとか習わかったのか？

563:デフォルトの名無しさん
08/04/29 14:57:59
>>562
もしかして日本語がやばいんじゃないか？

564:546
08/04/29 15:12:04
>>563
おぉ、そうかもしれん＞俺の日本語 Www
だれどさ、院出てから、10年以上この業界に巣食ってるけど、
いままでお目にかかったことがない＞こんなクライアント

565:デフォルトの名無しさん
08/04/29 15:23:28
クライアントは何屋さん？

566:546
08/04/29 15:44:01
>>565
今まで、地方自治体外郭団体向けに事務処理ソフト作って{る|た}会社
>>564 書く直前に
「理工系の知り合いに聞いたら、うちが悪かった」
って，電話入ってきた。
まぁ、>>564 ただの愚痴だし、確に、俺も悪かった思うが………
こんなに、言語の差があるもんなのか？

567:デフォルトの名無しさん
08/04/29 16:41:31
とりあえず日本語でおｋ

568:デフォルトの名無しさん
08/04/29 16:46:09
まぁ、独自プロトコルを定義した仕様書を今まで見たことないんだろうね。
いつまでも自分流儀でやって、愚痴たれながしとけばいいよ。

569:デフォルトの名無しさん
08/04/30 00:07:17
事務処理オンリーだった会社じゃ通じなくても不思議はない。
不思議はないが不甲斐ないな、そこ。

570:デフォルトの名無しさん
08/04/30 02:15:31
>>543
VS2005ならDoxyCommentがいいんじゃね
書式もカスタマイズできるし

571:デフォルトの名無しさん
08/04/30 02:52:52
正直、ドキュメントが読めない
ＤＢの構成とか設計書とか。
「読んだら分かる」っていつも言われるんだけど、
どうしたらいいかな。

572:デフォルトの名無しさん
08/04/30 03:18:04
>>571
落ち着いてジックリ読んでみな。

573:デフォルトの名無しさん
08/04/30 10:43:42
>>566
そう言う所は、得てして「うちはどこそこの仕事をしているんだ」って妙な自負があるから
こっちが何を書いてもクレームつけるよ。謝罪の電話があっただけでもましな方かも。
# うっかりしていると、同じドキュメントを「概要」と「詳細」と「解説」の3バージョン作る羽目になったり。

574:デフォルトの名無しさん
08/04/30 13:11:38
これはいい勉強になるスレ

575:デフォルトの名無しさん
08/05/01 21:02:41
>>571
ドキュメントは読めるようになったほうがいいよ。人に
頼ることなく進む力がぐんと増える。(ドキュメントに
頼る時点で、というのは無しで)

どうしたらいいかと言われると解答に困るんだけど、
日頃から疑問に思ったことがあれば、まずドキュメントに
目を通すという習慣をつけてみたらどうだろう。

java でプログラミングしてて分からないことがあったら
まず javadoc を当たってみて、それでも分からなければ
ぐぐってみたりとか。
ツールのインストールの時も、まずは付属ドキュメント
(README, INSTALL みたいなやつ) に目を通すとか。

576:デフォルトの名無しさん
08/05/02 10:31:47
それ、「～ほうがいいよ」ってレベルじゃなくて、「～できなきゃダメ」のレベルだと思う。

577:デフォルトの名無しさん
08/05/03 13:36:57
>>546
遷移図は全体を出さずに、

　ほげをするとBになります
　A→B

　ここでげほをするとCになります
　A→B→C

　ここでほれをするとAになり、やりなおしできます
　A→B→C┐
　 ←─┘

まあなんだ、たぶん図は崩れたと思うけど、インクリメンタルに
説明と共に図を成長させると理解してもらいやすい。

パワポのアニメで説明するとわかったきになるのに、
紙に出した同じ資料がわかりにくいのも同じ理由だと思う。

578:デフォルトの名無しさん
08/05/06 04:58:29
>>572
>>575

遅くなったけど、ありがとう。
疑問を持ったら人に聞くクセをなくすように
がんばります。

579:デフォルトの名無しさん
08/05/08 17:47:02
今度開発の仕事やらせてもらう事になりました。
その前に勉強として、仕様書作ってプログラム作れって上司から
言われました。
プログラムは作ったことあるんですが、仕様書なんて作ったことありません。
常識的に考えたら、基本設計書、概要設計書、コード設計書とか全部作るべきでしょうか？

580:デフォルトの名無しさん
08/05/08 20:27:21
上　司　に　聞　け

581:579
08/05/08 23:52:12
>>580
言葉足らずですみません。
仕様書って何の事か聞いたんですが、自由に作っていいって言われたんです。
自由に作れと言われたら基本的な概要、機能とか画面構成など書けば仕様書としては
成り立つんだと思うんですが、いかんせん初めての経験なのでどのように書いたらいいか
わからないんですよね。
社会人の常識として設計書の本読んで基本設計書、概要設計書
など全ての設計書を作るのが妥当なのかという質問です。

582:デフォルトの名無しさん
08/05/09 00:08:07
単なる練習プログラムなんだから概要からでいいんじゃね

583:デフォルトの名無しさん
08/05/09 03:44:01
上司乙ｗ

584:デフォルトの名無しさん
08/05/09 08:08:02
>>581
疲れたので途中で止めとくけど、こんな感じで読める読み物を作ればおけ。

ゴールの定義
・どういう背景があり（どういう歴史があり何で困っていたのか）
・何を実現したいと考えています（作ったものを使うことで得られると期待される効果のこと）
・このために何々をするものを作ることにしました

全体構造
・大きな制約条件として～がある中で（納期、コスト、現状からくる技術�%A

585:デフォルトの名無しさん
08/05/09 08:09:41
あれ？途中で切れてしまった・・・
書き直すもの疲れたので諦めるすまん>>581

586:デフォルトの名無しさん
08/05/09 09:40:43
骨組みでこの程度がわかれば良い。
・なんで作ったのか
・それを使ってどういう効果が期待できるか
・必要とする環境
・入力は何か
・出力は何か

競合するプログラムが既にある場合を除いて、
最初はどういう機能がとか、画面が云々とかは不要。
必要だといわれたら付け足していけば良いはず。
読む側にとってどうでもよさそうな事は極力避ける事。
つーか多分作ったのを後で添削するのが
意図なわけだから、あまり時間掛けると嫌われるぞ。

587:581
08/05/09 16:21:25
>>586
入力、出力ってどういう意味ですか？
A4用紙一枚にまとめるのは変でしょうか？

588:デフォルトの名無しさん
08/05/09 16:40:36
>>587
入力も出力もないプログラムは役に立たないだろう
記述が必要十分なら一文字にまとまっていても構わないぞ

589:581
08/05/09 17:00:35
>>588
もしデータベースを扱うプログラムだったら、
どのようなデータを登録して（入力）、どのような形で表示するか（出力）
簡単に言えばこのような事でしょうか？

590:デフォルトの名無しさん
08/05/09 20:04:08
電卓のイメージなら簡単だろ？
ユーザーが入力して、プログラムがそれを計算する。（出力）

591:デフォルトの名無しさん
08/05/10 01:11:34
上司から言われたことの真の目的を明確にして、その目的を達成するためのプロセスや成果物を決めたらどうだろうか？
社会人の常識とかじゃなくて、目的から考えた方がよいのでは

592:デフォルトの名無しさん
08/05/10 10:46:22
クラスの仕様の概要って、どこまでが概要ですか？

593:デフォルトの名無しさん
08/05/10 10:52:50
>>592
クラス仕様の詳細じゃない部分

594:デフォルトの名無しさん
08/05/10 11:23:40
>>592
・そのクラスの責任範囲と全体の中での役割
・超簡単なサンプル使用例
・データの流れと関与する主要APIを図示したもの（ポイントとなるクラスの場合）

これが１ページで欲しい所。

595:デフォルトの名無しさん
08/05/26 16:40:33
doxygenについて質問したいのですが、専用スレが無いようなのでこちらでさせてください。
PC:Windows XP
コンパイル方法:Visual Studio 2005のコマンドプロンプト上で、下記の命令をする
　make msvc
C:\doxygen1.5.5 に doxygen1.5.5.src.tar.gz を解凍した中身を置きました。
C:\doxygen1.5.5\src　のソースをいじって、コンパイルしましたがエラーが出てしまいます。
エラー内容
----
　link /NOLOGO /LIBPATH:..\lib /SUBSYSTEM:console /OUT:..\bin\doxygen.exe
　@C:\DOCUME~1\AA\LOCALS~1\Temp\nm2E.tmp
　～
　doxycfg.lib(portable.obj) : error LNK2019: 未解決の外部シンボル __imp__libiconv_open が関数 "void * __cdecl portable_iconv_open(char const *,char const *)" (?portable_iconv_open@@YAPAXPBD0@Z) で参照されました。
　～
　..\bin\doxygen.exe : fatal error LNK1120: 外部参照 5 が未解決です。
　NMAKE : fatal error U1077: 'link' : リターンコード '0x460'
----
doxygenのソースのコンパイルは、下記以外に必要なものはありますか？
・Active perl
・GnuWin32のFlex
・Qt
・VC2005
・Microsoft Platform SDK

596:デフォルトの名無しさん
08/05/26 17:33:49
libiconvって書いてあるじゃん。
エラーメッセージぐらい読めるようになったら？

597:595
08/05/26 18:28:33
>>596
ありがとうございます。
iconv.lib,iconv.hがdoxygenのソース内に入っていたのでこれで良いのかと思っていました。
Libiconvをコンパイルしたものと差し替えたら、コンパイルが通過して下記ファイルが出来ました。
　doxygen.exe
　doxytag.exe

598:ura2ch.czsoftbank219174032071.bbtec.neta.net
08/05/26 18:33:08
guest/guest

599:デフォルトの名無しさん
08/05/28 23:41:27
開発の人間なら仕様書を云々言う前に
ソース内のコメントをちゃんと書け！

と思う、インフラ屋は俺だけではないはず。

特にリリース後の修正箇所に対して正確な
コメントが書かれているソースが本当に少ない。

頼むから引数のコメントくらい、まともに書いてくれ・・・・

600:デフォルトの名無しさん
08/05/30 04:18:14
変数名自体を説明にするしかない

601:デフォルトの名無しさん
08/05/30 13:08:41
システムハンガリアンを止めて、アプリケーションハンガリアンにする。

602:デフォルトの名無しさん
08/05/31 00:23:06
>>599
> 特にリリース後の修正箇所に対して正確な
> コメントが書かれているソースが本当に少ない。

これはコミットログやChangeLogの役目だろう

603:デフォルトの名無しさん
08/05/31 13:13:14
> これはコミットログやChangeLogの役目だろう
ソース内のロジックとコメントは分業してるってこと？

ロジックとそのコメント内容が一致してないから
障害対応してるときに頭からソースを読まなければ
ならないってこと。
そして、修正したPGはすでにいないことが多い・・・・

604:デフォルトの名無しさん
08/05/31 17:32:04
コメントとソースを同じくらい価値があるものだと考えるのはいいが
コメントとソースを同じように扱ってはいけないだろ

605:デフォルトの名無しさん
08/05/31 18:51:02
そこまでコメントに期待してないよ。
ただ最初にも書いたけど、表題部の
プログラム名や用途、引数説明すら
まともに書いてないソースが多すぎる
からカキコしただけだ

606:デフォルトの名無しさん
08/05/31 19:19:50
doxyの1.5.6でツリーが文字化けするのって俺だけ？
1.5.5平気なんだけど

607:デフォルトの名無しさん
08/05/31 21:19:45
４コマ漫画で８００ページの取扱い説明書

608:デフォルトの名無しさん
08/05/31 22:24:13
>>603
> 特にリリース後の修正箇所に対して正確な
> コメントが書かれているソースが本当に少ない。

これは「こう修正しました」っていうコメントのことでしょ？
それはまさにコミットログ等の役割
コードからは読み取れない「こういう処理です」っていうのがコメントの役割だと思う

609:デフォルトの名無しさん
08/06/01 01:34:08
>>608
"「こう修正しました」"は
ソース内の修正(変更)履歴のことを言ってる。

610:デフォルトの名無しさん
08/06/01 01:53:13
>>609
そりゃあSCMがない時代の苦肉の策でしょ

611:デフォルトの名無しさん
08/06/01 09:06:34
>>609
バージョン管理使おうぜ

612:デフォルトの名無しさん
08/06/01 11:47:08
>610,611
今、休出でVSS見てるけど、コミットログやChangeLogは存在しない。
各ソースのチェックインコメントは全部一緒で"○○○○更改に対する修正"・・・・
ほかに見るとこあれば教えてくれ。

（インフラ側で作ってる基盤モジュールのアップデート履歴のほうが
詳細に記載している。）

613:デフォルトの名無しさん
08/06/01 17:35:45
>>612
履歴を残そうという意識が作業者に無ければコミットログにも残るわけ無いだろ。
お前んとこのローカルな事情だな、それは。

で、一般的に履歴を残すんならどっちかというとコミットログのほうが適切という話。

614:デフォルトの名無しさん
08/06/01 17:43:21
>>612
コミットログはチェックインコメントと同じ意味
ツールが違うと用語が違う
チェックインコメントが全部一緒だと無意味だと感じませんか？
チェックインコメントは修正内容を記録するのにうってつけだと思いませんか？

615:デフォルトの名無しさん
08/06/01 17:49:07
ソースに履歴コメントされても探すのが大変だし。同時に変更したファイルの関連や前後関係も把握するのも正確に記載するのも困難。
コミットログならすぐ探し出せる。コメント漏れがあっても差分を見つけられる。
コミットログに情報がないというのは、結局コメントの入れ方、運用の問題でしょ。

616:デフォルトの名無しさん
08/06/01 19:27:14
ソースが動かないというのは、結局プログラムの書き方、プログラミングの問題でしょ
みたいな感じに見えた

617:デフォルトの名無しさん
08/06/02 15:25:20
【コメント】doxygen【コンソメ】
ｽﾚﾘﾝｸ(tech板)

618:デフォルトの名無しさん
08/07/27 04:43:22
doxygenの話題は禁止

619:デフォルトの名無しさん
08/08/23 14:10:15
URLﾘﾝｸ(www.hotdocument.net)
じゃだめかな。

620:デフォルトの名無しさん
08/08/23 18:05:57
これはひどい

621:デフォルトの名無しさん
08/11/17 15:02:59
doxygen,hotdocument,visio

どれがいいだろうか・・・
C++Builder2007なんだけど。どれ対応してるかもまだ調べてないんだ。

とりあえず・・・探すか。