knowledge-capture_skill

Overview

This skill captures and organizes business rules, technical patterns, and external interface contracts discovered during analysis or implementation. It enforces a three-folder documentation hierarchy (domain, patterns, interfaces) and mandates deduplication before creating new files. The goal is searchable, maintainable docs that get updated rather than duplicated.

How this skill works

When you discover reusable logic, integrations, or implementation patterns, run the deduplication checks against docs/ first. If existing content covers the topic, update that file; otherwise determine the correct category (domain, patterns, interfaces), create a descriptive filename, apply the appropriate template, and add cross-references. The skill also records a short report of files created or updated.

When to use it

• When you find business rules, workflows, or domain validation logic
• When you discover reusable technical or architectural patterns
• When you integrate with third-party APIs, webhooks, or external services
• When you add or change public API contracts or service interfaces
• Before opening a PR that introduces reusable knowledge or breaking changes

Best practices

• Always perform deduplication searches (grep/find) before creating a new doc
• Prefer updating an existing, related document instead of creating a duplicate
• Use clear, searchable filenames (avoid vague names like api.md or auth.md)
• Follow the template for the chosen category: domain, pattern, or interface
• Include title, context, details, examples, references, and cross-links in every doc
• Add the required end-of-task report listing docs created/updated and the action taken

Example use cases

• Implementing Stripe or SendGrid integration → create docs/interfaces/stripe-payments.md and use interface template
• Discovering a common caching approach in multiple modules → update or create docs/patterns/caching-strategy.md
• Defining user permission rules discovered during analysis → update docs/domain/user-permissions.md
• Noticing a new public endpoint or changed signature → create/update interface doc and flag for cross-reference updates
• Finding a new validation rule for orders → add to docs/domain/order-validation.md and link related workflow docs