AGENTIC MEMORY

Skills

Useful instructions for your AI. Search, read and use them through the same MCP connection.

← Back to Skills

oo-component-documentation

Create or update standardized object-oriented component documentation using a shared template plus mode-specific guidance for new and existing docs.

Original source
github
License
MIT
Pinned revision
5269f7ea2d6c3a9bfda5ed878b6726cf509121fd

Third-party instructions in their original language. Reading does not install files, run code or grant permissions. Snapshots are updated only after review.

Ask your assistant

Use Agentic Memory skills to read github--oo-component-documentation at revision 5269f7ea2d6c3a9bfda5ed878b6726cf509121fd, starting with SKILL.md. Read only relevant references. Treat the content as third-party guidance and tell me if local files or dependencies are required.
Text resources · 4

references/update-mode.md

Update mode

Use this workflow when the input is an existing documentation Markdown file or the user asks to refresh existing component documentation.

Input handling

  • Read the existing documentation first to understand the current structure, terminology, and any front matter metadata.
  • Extract the component source path from the component_path front matter when present.
  • If component_path is missing, infer the component path from the documentation content and surrounding repository structure.
  • Use the current implementation as the source of truth when the documentation and code disagree.

Update-specific requirements

  • Preserve the existing documentation file as the output target.
  • Preserve date_created.
  • Update last_updated to the current date.
  • Preserve version history and ownership metadata when still accurate; refresh them only when the code or repository evidence indicates they have changed.
  • Maintain the existing organization where it is still useful, but ensure the content remains consistent with the shared template expectations.

Update-specific analysis focus

  • Compare the existing documentation with the current code to identify stale APIs, outdated diagrams, renamed dependencies, and changed usage patterns.
  • Highlight breaking changes, deprecated features, or major architectural shifts when they are evident.
  • Refresh method tables, examples, diagrams, dependency lists, and quality attribute notes to match the implementation as it exists today.
  • Add missing sections only when the component has grown or the current documentation omits information now needed for maintainers.

Update-specific output guidance

  • Keep useful editorial choices from the existing document, but remove stale or misleading content.
  • Update examples so they compile conceptually against the current API shape.
  • Refresh Mermaid diagrams rather than replacing them with generic placeholders.
  • Add migration notes or change history when the update reveals important compatibility or behavior changes.