AgentSkillsCN

documentation-process

在完成新功能的实现或修复 Bug 后,务必及时记录相关变更。适用于在功能实现阶段或 Bug 修复完成后进行文档化。

SKILL.md
--- frontmatter
name: documentation-process
description: After implementing a new feature or fixing a bug, make sure to document the changes. Use after finishing the implementation phase for a feature or a bug-fix

Documentation Process

Guidelines

  1. After completing a new feature, always see if you need to update the Architecture documentation at /docs/contributing/ARCHITECTURE.md and Test documentation in /docs/contributing/TESTING.md for other developers, so anyone could easily pick up the work and understand the project and the feature that was added.
  2. If the code change included prior decision-making out of several alternatives, document an ADR at /docs/adr for any non-trivial/non-obvious decisions that should be preserved.