質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.50%
ドキュメント

ドキュメントは、IT用語では、ソフトウェアやハードウェアに関する情報であり、意図された目的、機能性、メインテナンスを含みます。ドキュメントは、多くの様々なフォームとフォーマットに存在しますが、その目的は常に教育することにあります。

Q&A

解決済

3回答

5579閲覧

個人開発で、設計書などのドキュメント類は作ってますか?

komachi

総合スコア94

ドキュメント

ドキュメントは、IT用語では、ソフトウェアやハードウェアに関する情報であり、意図された目的、機能性、メインテナンスを含みます。ドキュメントは、多くの様々なフォームとフォーマットに存在しますが、その目的は常に教育することにあります。

0グッド

1クリップ

投稿2015/05/11 11:56

掲題の通りです。
個人で趣味の範囲でアプリを作ったりしていますが、過去に書いたコードを見てみると、何を書いてあるかサッパリ。。。。なんてことありませんか?

おそらく、ドキュメントにしてまとめたほうが良いのでしょうが。

コード中のコメントに残すのも気がひけるし、設計書かくの面倒だし、、、

みなさまはどう管理していますか?

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答3

0

ベストアンサー

こんにちは。

過去に書いたコードを見てみると、何を書いてあるかサッパリ。。。。なんてことありませんか?

よくあります。

私は趣味で作るアプリであれば設計書は作りません。
(メモ書きとはしますが保管しませんね。)
で、サッパリな自分のコードに再開した時は良い機会なので、ガッツリとリファクタリングします。

言語にもよるとは思いますが、時間を空けて改めてコードを見た時に直観的によくわからないような場合はそもそもコードに問題があるのかなぁなんて、そういうコードは他人が見ても、きっとサッパリだと思いますし、わかりやすい実装を行う力を身に着ける良い機会だと割り切ってます。

そして何より設計書を書くのが面倒ですし。
設計スキルは上がらないかもしれませんが。

#趣味で作る、自分のみまたは限られた人しか使わないようなものに限ります。

投稿2015/05/11 13:56

Tak1wa

総合スコア4791

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

komachi

2015/05/12 03:42

ご回答をありがとうございます。とても共感できます。昔のコードをリファクタして初めて気づく改善点があります。確かに成長につながりますね。
guest

0

Doxygenでドキュメントを生成できるようにコメントを書いています。

取っ掛かりが少々面倒(設定ファイルの記述やソース中のコメント記述方法など)ですが、雛形を1クラス作ってしまえばあとはコピペでいけるので、一度お試ししてはいかがでしょうか。

以前はJavaDocやphpDocumentorなんかを使用していましたが、Doxygenだと色々な言語に(ある程度)対応しており、コメントの記述方式が一本化できるので乗り換えました。

投稿2015/05/11 12:56

hyper-drums-ko

総合スコア736

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

komachi

2015/05/12 03:38

ご回答をありがとうございます。doxygenは初めて知りました。参考にさせていただきます。
guest

0

複雑な仕様を対応する場合ほど、簡単な絵と設計イメージの大まかな概要をテキストでまとめる
事はしてますね。
最近は、markdownで残せるタイプもあり利用してます。

投稿2015/05/11 12:53

lib

総合スコア446

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

komachi

2015/05/12 03:39

ご回答をありがとうございます。mdは見やすくて便利ですよね。
guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.50%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問