bkit-templates_skill

Overview

This skill provides PDCA document templates for consistent planning, design, analysis, and reporting. It packages ready-made Plan, Design, Analysis, and Report templates with standard headers, versioning, and file structure to accelerate and standardize documentation. Use it proactively when generating PDCA documents to ensure consistent format and traceability.

How this skill works

The skill supplies markdown templates that enforce a uniform structure: common header, version history, cross-references, and status tracking. Each template targets a PDCA phase (Plan, Design, Analysis, Report) and includes recommended sections like requirements, architecture, gap comparisons, and lessons learned. Variables such as {feature}, {date}, and {author} are substituted into filenames and headers so generated documents fit the repo layout and naming rules.

When to use it

• When creating a new feature plan before design work
• When documenting technical architecture and API specifications
• When performing gap analysis between design and implementation
• When producing a completion report and lessons learned
• When you need consistent headers, version history, and cross-references

Best practices

• Populate the common header (Summary, Author, Dates, Status) for every document
• Follow the file-naming conventions and place files in the prescribed docs/ folders
• Keep version history up to date with concise change notes and dates
• Link related Plan, Design, Analysis, and Report documents using cross-references
• Treat code as the source of truth when resolving design vs implementation mismatches

Example use cases

• Create a feature.plan.md before starting implementation to capture scope, requirements, success criteria, and risks
• Draft a feature.design.md with architecture diagrams, data models, API specs, and test plans
• Run a feature.analysis.md to compare design against implemented code and list missing items and quality metrics
• Publish a feature.report.md at completion summarizing metrics, issues, lessons learned, and future improvements
• Use _INDEX.md files to surface document status and direct reviewers to the latest approved artifacts