oo-component-documentation

原文涵盖的主题

• OO Component Documentation
• Determine the mode first
• Documentation standards
• Shared analysis guidance
• Shared output requirements
• Language-specific optimizations
• Error handling
• Workflow

Create new documentation for an object-oriented component or update an existing component documentation file by analyzing the current implementation. Choose the workflow before writing anything: 1. Use update mode when the user provides an existing documentation Markdown file, points to a docs path, or explicitly asks to refresh or revise existing documentation. Follow references/update-mode.md. 2. Use create mode when the user provides a source file or folder, points to a component path, or asks to generate documentation from code. Follow references/create-mode.md. 3. If both code and an existing documentation file are provided, treat the existing documentation file as the output target and use the current source code as the source of truth. 4. If the request is ambiguous, infer the mode from the path type whenever possible: existing Markdown documentation file means update mode; source/component path means create mode. DOC-001: Follow C4 Model documentation levels (Context, Containers, Components, Code) DOC-002: Align with Arc42 software architecture documentation template DOC-003: Comply with IEEE 1016 Software Design Description standard DOC-004: Use Agile Documentation princip

这里只展示节选，请以完整原文和当前要求为准。