実例マッピング

Example Mapping #Documentation Agile Testing、BDDで紹介されるプラクティス。 マッピングする付箋の種類には Story Rule Example Question の4種があり、あるStoryにおけるExample（実例）を軸に、定められるRuleと残論点としてのQuestionをマッピングする 【翻訳記事+α】受け入れ基準の設定時などに役立つプラクティス「実例マッピング(Example Mapping)」 今日から使える「実例マッピング」

ADR

Architectural Decision Records #Documentation アーキテクチャに関する意思決定とその理由を記録する文書。意思決定に際する文脈、根拠、その決定による成果物等を記述する ADRはなぜそのアーキテクチャを選出したかの意思決定を理解するのを助ける。 ADRはチームメンバーの誰もが作成できる。ただしオーナーシップとしてAuthorは明確にする必要がある。初期ステータスは Proposed とする。 次に他チームメンバーによるレビューを行う。修正すべき点がある場合は Proposed のままアクションのアサインを行う。このときアサインはチームメンバーの誰でもよい。ADR自体はRejectする場合はステータスを Rejected にしADRのライフサイクルは終了する。 レビューを経て全てのアクションが完了した場合、ステータスを Accepted にする。一度AcceptされたADRはイミュータブルに扱い変更はしない。 Architectural Decision Records (ADRs) ADR process - AWS Prescriptive Guidance

仮説キャンバス

#Agile #Documentation

Open API

#Documentation #API Architecture HTTP APIの動作を記述するためのオープンで標準的な仕様。リクエストからレスポンスまでAPIのライフサイクルを説明できる JSONまたはYAMLでコード管理が可能 Swaggerのようなツール群ではOpen API仕様をベースにドキュメンテーションやテストを用意に実装できる What is OpenAPI? - OpenAPI Initiative

DevOps capabilities

#DevOps Capabilities that enable a Climate for Learning Code maintainability Documentation quality #Documentation Empowering teams to choose tools Generative organizational culture Job satisfaction Learning culture Team experimentation Transformational leadership Well-being Capabilities that enable Fast Flow Continuous delivery Database change management Deployment automation Flexible infrastructure Loosely coupled teams Streamlining change approval Trunk-based development トランクベース開発 Version control #Version Control Visual management Work in process limits Working in small batches Capabilities that enable Fast Feedback Continuous integration #Continuous Integration Customer feedback Monitoring and observability #Observability Monitoring systems to inform business decisions Pervasive security Proactive failure notification Test automation Test data management Visibility of work in the value stream DORA | Capabilities

Redoc

#Documentation Open API仕様を元にドキュメンテーションを行いシンプルなUIで表示される CLIによるドキュメント生成またはHTMLファイルへのscript埋込が可能 Redoc

ユーザーストーリーマッピング

#Agile #Documentation Blog / Agile Studio

MADR

Markdown Architectural Decision Records #Documentation ADRを記述するテンプレートカテゴリの一つ。マークダウンによって構造化された文書を提供する いくつかのテンプレートは以下から参照可能 https://github.com/adr/madr/tree/develop/template About MADR | MADR

C4 model

#Documentation 以下の4つのダイアグラム図を表すアプローチ Context Diagram Container Diagram Component Diagram Code Diagram 順に抽象度が下がっていく流れになっている Home | C4 model

Swagger