Are there specific requirements for diagrams?

Yes, the skill specifies required Mermaid diagrams for each document type, such as user journeys for PRDs, architecture diagrams for Design Docs, and task dependency diagrams for Work Plans.

Does this skill provide actual templates?

Yes, it includes standardized markdown templates for Product Requirements (PRD), Architecture Decisions (ADR), Technical Design, and Work Plans to ensure team-wide consistency.

What triggers a mandatory ADR according to these criteria?

ADRs are mandatory if you are changing contracts used in 3+ locations, modifying data flow (e.g., DB to Cache), adding complex asynchronous processes, or changing architecture layers.

When should I create an ADR versus a Design Doc?

An ADR is required for high-impact technical decisions like contract changes or new dependencies, while a Design Doc defines the specific implementation methods for features typically affecting 3 or more files.

How does the Work Plan help with quality assurance?

The skill enforces a mandatory Phase 4 Quality Assurance step in every work plan, ensuring that acceptance criteria are met and all tests pass before a task is considered complete.

Documentation Standards & Criteria

Name: Documentation Standards & Criteria
Author: Tahir-yamin

byTahir-yamin

•

콘텐츠 관리

Establishes standardized criteria and templates for technical documentation including PRDs, ADRs, Design Docs, and Work Plans.

This skill provides a comprehensive framework for engineering teams to determine when and how to create essential technical documentation. It features a decision matrix that triggers the creation of Architecture Decision Records (ADRs) or Design Documents based on the complexity and scale of code changes. By providing standardized templates and clear definitions for Product Requirements Documents (PRDs) and Work Plans, it ensures consistency across the development lifecycle, improves architectural integrity, and streamlines task management with automated checks for file counts and contract changes.

주요 기능

01Detailed definitions for PRD success metrics, MoSCoW prioritization, and user journey diagrams

02Mandatory ADR triggers for contract changes, data flow modifications, and architectural shifts

033 GitHub stars

04Standardized templates for PRDs, ADRs, Design Documents, and Work Plans

05Structured work plan phases including foundation, core features, integration, and mandatory quality assurance

06Decision matrix for determining necessary documentation based on file scale and logic complexity

사용 사례

01Generating structured work plans with clear E2E verification steps and phase-based milestones

02Planning a new feature and determining if a PRD or Design Doc is required based on complexity

03Documenting a significant architectural change or library replacement using the ADR template

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tahir-yamin/dev-engineering-playbook documentation-criteria

For use in Claude.ai and ChatGPT

Download Skill