仕事でドキュメント(画面仕様書)を作成し、上司にレビューしてもらった際にいただいた指摘事項を「ドキュメント作成のポイント」としてまとめてみます。 個人的に重要だと感じた部分については、太字にしています。 1.<ドキュメント作成全般のポイント>・何について、誰に対して説明するのか、コンセプトを決めてから作成する ・全体の構成を考えるため、まず目次を書いてから内容に着手する ・ドキュメント全体を通して「文章」になるようにする ・良いドキュメントとは、理解するために何度も読み返す
■0.初めに使用モデル: Raspberry Pi 4 Model B(以下、ラズパイ) 参考書: これ1冊でできる! ラズベリー・パイ 超入門 改訂第6版 Raspberry Pi 1+/2/3/4/Zero/Zero W対応 https://www.amazon.co.jp/%E3%81%93%E3%82%8C1%E5%86%8A%E3%81%A7%E3%81%A7%E3%81%8D%E3%82%8B-%E3%83%A9%E3%82%BA%E3%83%99%E3%83%
どうも、ミイという者です。 NOTE に登録したものの、何も書いていなかったので自己紹介でもしようと思います。 どれも執筆当時 ( 2021年 ) のものです。 ------仕事関連------ ・社会人2年目 ・SE 目指して頑張ってる初級プログラマー ・経験言語 : Java, C#, VB ・仕事がポンコツで参ってる今日この頃 ------趣味------ ・作ることが好き ・動画製作 ( ゲーム実況 ) ・模型製作 ・3DCG ・ゲームプログラミング NOTE