name: process-documentation
description: Enforces comprehensive documentation of all processes and changes. Provides templates for features, bug fixes, refactors, and ADRs with structured format and validation checklist.
allowed-tools:
- file-operations
- read-file
- write-file

Process Documentation Skill

Overview

This skill ensures that all significant changes, features, bug fixes, refactors, and architectural decisions are properly documented with context, rationale, and impact analysis.

Objective

Enable comprehensive documentation of development processes to maintain clear project history, facilitate knowledge transfer, and support decision-making.

Templates

Feature Documentation

# Feature: [Feature Name]

## Context

[Why this feature is needed]

## Implementation

[How it was implemented]

## Changes

- [File/component changed]
- [New dependencies added]
- [Configuration updates]

## Testing

[How to test this feature]

## Impact

[Performance, bundle size, breaking changes]

Bug Fix Documentation

# Bug Fix: [Issue Description]

## Problem

[What was broken]

## Root Cause

[Why it was happening]

## Solution

[How it was fixed]

## Prevention

[How to avoid this in the future]

Refactor Documentation

# Refactor: [Component/Module Name]

## Before

[Original implementation approach]

## After

[New implementation approach]

## Rationale

[Why the change was made]

## Breaking Changes

[If any]

ADR (Architectural Decision Record)

# ADR: [Decision Title]

## Status

[Proposed | Accepted | Deprecated | Superseded]

## Context

[The issue requiring a decision]

## Decision

[The chosen solution]

## Consequences

[Positive and negative outcomes]

## Alternatives Considered

[Other options evaluated]

Conventions

When to Document

• New features or capabilities
• Bug fixes (especially non-trivial ones)
• Refactors affecting multiple files
• Architectural decisions
• Breaking changes
• Performance optimizations

Documentation Location

• Feature docs: /docs/features/
• Bug fixes: Reference in commit messages or /docs/fixes/
• Refactors: /docs/refactors/
• ADRs: /docs/adr/

Validation Checklist

• [ ] Clear context provided
• [ ] Implementation details explained
• [ ] Impact analyzed
• [ ] Testing approach defined
• [ ] Breaking changes identified
• [ ] Related files/components listed

References

• ADR GitHub Template