Prompt Editor

Refine, edit, and optimize your generated prompt.

Ready for your AI model

Generate a comprehensive implementation plan for documenting the codebase.

**Plan Requirements:**

1.  **Codebase Analysis Strategy:** Outline a methodical approach to understand the codebase structure, modules, functions, and key functionalities relevant for documentation.
2.  **Documentation Scope & Types:** Identify essential documentation types required (e.g., API reference, user guides, architectural overview, setup guides, contributor guidelines).
3.  **Tooling & Format Recommendation:** Suggest appropriate documentation tools and formats (e.g., Markdown, Sphinx, Doxygen, OpenAPI, JSDoc) based on typical project needs.
4.  **Content Creation Strategy:** Detail step-by-step instructions for generating documentation content, including identifying information sources, writing guidelines, and review processes.
5.  **Structure & Organization:** Define a logical, navigable structure for the documentation, including sections, subsections, and hierarchy.
6.  **Maintenance & Versioning:** Propose methods for keeping documentation current, synchronized with code changes, and integrated with version control.

Metadata

Target Engine

Llama

Prompt Editor

Refine, edit, and optimize your generated prompt.

Ready for your AI model

Generate a comprehensive implementation plan for documenting the codebase.

**Plan Requirements:**

1.  **Codebase Analysis Strategy:** Outline a methodical approach to understand the codebase structure, modules, functions, and key functionalities relevant for documentation.
2.  **Documentation Scope & Types:** Identify essential documentation types required (e.g., API reference, user guides, architectural overview, setup guides, contributor guidelines).
3.  **Tooling & Format Recommendation:** Suggest appropriate documentation tools and formats (e.g., Markdown, Sphinx, Doxygen, OpenAPI, JSDoc) based on typical project needs.
4.  **Content Creation Strategy:** Detail step-by-step instructions for generating documentation content, including identifying information sources, writing guidelines, and review processes.
5.  **Structure & Organization:** Define a logical, navigable structure for the documentation, including sections, subsections, and hierarchy.
6.  **Maintenance & Versioning:** Propose methods for keeping documentation current, synchronized with code changes, and integrated with version control.

Metadata

Target Engine

Llama

CatalystPrompt Studio

Prompt Editor

Metadata

CatalystPrompt Studio

Prompt Editor

Metadata