8
6

More than 3 years have passed since last update.

開発者のためのドキュメンテーションガイド (Documentation Guide for Developers)

Posted at

Documentation Guide for Developers という記事のテンプレートが便利そうだったのでそのメモ。

筆者: https://github.com/Neha/documentation

テンプレート集

Feature and approaches / 機能とアプローチ

解決策:

異なる解決策
理由
解決策の詳細設計
依存関係
API
トレードオフ
LLD (ローレベルデザイン)
HLD(ハイレベルデザイン)

Knowledge sharing / 知識共有

あらゆる技術の初期評価
学んだこと
修正したバグ
あるべき機能
複雑な機能

Code guidelines / コードガイドライン

Checklist / チェックリスト

Dependencies / 依存関係

Sprint reviews / スプリントレビュー

というところで、以上参考になればさいわいです。

8
6
1

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
8
6