syobochim / doc Goto Github PK

書ける範囲で追加する

もし文書についてコメントを募りたい場合は、文書の目に付きやすいところ (#4 で作成するページあたり) に、この issue 登録先や連絡先を記載する。

どうやったら品質担保できるんだろう。。。

• チェックシート
• 設計書の塗りつぶし
• mvn verifyかJenkinsのJOBチェック
• カバレッジチェック
• 動作確認

SIerっぽいことを書きたい。

レビュアーがローカルで動作確認をする時の手順を書く

(もちろん書ける範囲で構わないので、)

• 仕事の形態
  • プロジェクトなのかプロダクトなのか
• 成果物の取り扱い
  • 以下のどのパターンなのか?
    • 納品物として納め、(ソースコードも) 手元に残らない。
    • 客先環境に構築はするが、会社の著作物として手元に残る。
    • 社内環境にインストールし、サービスとして提供する。当然、会社の著作物として手元に残る。
• 開発規模
• チーム編成
  • チームの区切り
  • チーム内の人員の構成
  • 1つのチームが担当する規模
• 他のプロジェクト/プロダクトとの関係 (※これはモジュールごとに異なる可能性がある)
  • 以下のどのパターンなのか?
    • 今まで使われていたものを流用するもの
    • 複数のチームで共有するもの
    • 後々の仕事で使われる (可能性のある) もの

conf.py に html_static_path = ['_static'] という設定があるので、 source/_static 以下に配置するのが良い。

やっぱりドキュメントだけ渡して、「はい、やってね。」は厳しい。
動画なり gif なり作る…？
説明会を開けるのが一番良いので、アーキテクト用やることリストを作って、説明会の実施をリストにいれようか。

https://readthedocs.org/projects/syobochim-doc/builds/3663234/

測り方がわからない人もいるんですよ！

mavenコマンドにてhtml形式でのカバレッジレポートを出力することが出来ます。

以下コマンドを実行してください。

mvn clean verify jacoco:report

以下各モジュールの以下ディレクトリにhtml形式でカバレッジレポートを出力することが出来ます。

<<各モジュールのディレクトリ>>/target/site/jacoco/index.html
なお、Missed InstructionsがC0 (命令網羅率) でMissed BranchesがC1 (条件網羅率) を表しています。

文書の位置づけについて下記の項目を、メモ程度で良いので書いておく。

• 目的
• 想定読者
• 前提知識
• 書く内容
• 書かない内容