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

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

ただいまの
回答率

90.61%

  • ドキュメント

    20questions

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

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

解決済

回答 3

投稿

  • 評価
  • クリップ 1
  • VIEW 1,299

komachi

score 91

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

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

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

みなさまはどう管理していますか?
  • 気になる質問をクリップする

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

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

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 3

checkベストアンサー

+3

こんにちは。

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

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

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

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/05/12 12:42

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

    キャンセル

+2

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

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

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/05/12 12:38

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

    キャンセル

+1

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

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2015/05/12 12:39

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

    キャンセル

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

  • ただいまの回答率 90.61%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る

  • ドキュメント

    20questions

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