Revise Diátaxis Documentation Expert instructions #866
Conversation
Updated the documentation for the Diátaxis Documentation Expert agent, including guiding principles, task workflows, and project overview. Signed-off-by: Yī nuò <218099172+yi-nuo426@users.noreply.github.com>
✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR adds a new Diátaxis Documentation Expert agent configuration to the documentation agent file, prepending it to the existing Layer5 Docs coding agent instructions. The changes introduce a structured framework for creating documentation according to the Diátaxis methodology, which categorizes documentation into four types: Tutorials, How-to Guides, Reference, and Explanation. The PR also updates AI model recommendations and removes some development workflow instructions related to forking.
Key Changes
- Added frontmatter metadata defining the Diátaxis Documentation Expert agent with tools and description
- Introduced comprehensive Diátaxis framework guidelines including guiding principles, workflow, and document types
- Updated AI model selection guidance with new (questionable) model version names
| name: "Diátaxis Documentation Expert" | ||
| agent: 'agent' | ||
| tools: ['edit/editFiles', 'search', 'fetch'] | ||
| description: 'Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.' |
There was a problem hiding this comment.
[nitpick] The description in the frontmatter contains a redundant phrase. "Diátaxis Documentation Expert. An expert technical writer..." repeats the title unnecessarily. Consider removing the redundant "Diátaxis Documentation Expert." at the start of the description for better clarity. For example: "An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework."
| description: 'Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.' | |
| description: 'An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.' |
| - DO NOT copy content from them unless I explicitly ask you to. | ||
| - You may not consult external websites or other sources unless I provide a link and instruct you to do so. | ||
|
|
||
| # Coding Agent Instructions for Layer5 Docs |
There was a problem hiding this comment.
This document now contains two top-level H1 headers: "# Diátaxis Documentation Expert" (line 8) and "# Coding Agent Instructions for Layer5 Docs" (line 49). In well-structured Markdown documents, there should typically be only one H1 header. Consider either: 1) making "Coding Agent Instructions for Layer5 Docs" an H2 header (##) to indicate it's a subsection, or 2) reorganizing the document structure to clarify the relationship between these two sections.
| # Coding Agent Instructions for Layer5 Docs | |
| ## Coding Agent Instructions for Layer5 Docs |
| ## GUIDING PRINCIPLES | ||
|
|
||
| 1. **Clarity:** Write in simple, clear, and unambiguous language. | ||
| 2. **Accuracy:** Ensure all information, especially code snippets and technical details, is correct and up-to-date. | ||
| 3. **User-Centricity:** Always prioritize the user's goal. Every document must help a specific user achieve a specific task. | ||
| 4. **Consistency:** Maintain a consistent tone, terminology, and style across all documentation. | ||
|
|
||
| ## YOUR TASK: The Four Document Types | ||
|
|
||
| You will create documentation across the four Diátaxis quadrants. You must understand the distinct purpose of each: | ||
|
|
||
| - **Tutorials:** Learning-oriented, practical steps to guide a newcomer to a successful outcome. A lesson. | ||
| - **How-to Guides:** Problem-oriented, steps to solve a specific problem. A recipe. | ||
| - **Reference:** Information-oriented, technical descriptions of machinery. A dictionary. | ||
| - **Explanation:** Understanding-oriented, clarifying a particular topic. A discussion. | ||
|
|
||
| ## WORKFLOW | ||
|
|
||
| You will follow this process for every documentation request: | ||
|
|
||
| 1. **Acknowledge & Clarify:** Acknowledge my request and ask clarifying questions to fill any gaps in the information I provide. You MUST determine the following before proceeding: | ||
| - **Document Type:** (Tutorial, How-to, Reference, or Explanation) | ||
| - **Target Audience:** (e.g., novice developers, experienced sysadmins, non-technical users) | ||
| - **User's Goal:** What does the user want to achieve by reading this document? | ||
| - **Scope:** What specific topics should be included and, importantly, excluded? | ||
|
|
||
| 2. **Propose a Structure:** Based on the clarified information, propose a detailed outline (e.g., a table of contents with brief descriptions) for the document. Await my approval before writing the full content. | ||
|
|
||
| 3. **Generate Content:** Once I approve the outline, write the full documentation in well-formatted Markdown. Adhere to all guiding principles. | ||
|
|
||
| ## CONTEXTUAL AWARENESS |
There was a problem hiding this comment.
[nitpick] Inconsistent heading capitalization style within the document. The Diátaxis section uses ALL CAPS for headings like "GUIDING PRINCIPLES", "YOUR TASK", "WORKFLOW", and "CONTEXTUAL AWARENESS", while the Layer5 Docs section uses Title Case for headings like "AI Model Selection", "Project Overview", etc. For better consistency, consider using the same heading style throughout the document. Title Case is more commonly used in Markdown documentation.
Updated the documentation for the Diátaxis Documentation Expert agent, including guiding principles, task workflows, and project overview.
Notes for Reviewers
This PR fixes #
Signed commits