論理的に技術/非技術文書を構成するときに気をつけること
Context Freeに理解できる文章を書く
すべての文書は古くなることを前提とする
現時点でどうなのか,という記述に終始する
再現性のsectionにも書くけど,対象となるsystem versionは詳細に記述する
permalinkに注意する
再現性に気をつける
container image/git commit id/release versionはちゃんとかく
事実と解釈は区別して書く
それがわかるように文章を構成する
技術用語は困ったら英語表記
変に翻訳して検索しづらくしない
できるだけ一次情報を参考にし,必ずlinkする