AgentSkillsCN

process-documentation

全面记录所有流程与变更，为各项功能、Bug 修复、代码重构以及 ADR 提供标准化模板，并辅以结构化的格式与校验机制。触发时机：在完成新功能开发、修复 Bug、重构代码、做出架构决策，或在提交变更之前。

SKILL.md
--- frontmatter
name: process-documentation
description: Comprehensive documentation of all processes and changes. Templates for features, bug fixes, refactors, ADRs with structured format and validation. Trigger: When completing features, fixing bugs, refactoring code, making architectural decisions, or before committing changes.
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

markdown
# 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

markdown
# 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

markdown
# 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)

markdown
# 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