bobo-ai-cli 3.0.4 → 3.0.5

package/knowledge/skills/documentation-expert.md

@@ -1,126 +1,126 @@
----
-id: "documentation-expert"
-title: "Documentation Expert"
-category: "dev-tools"
-tags: ["documentation expert", "documentation types", "jsdoc/tsdoc patterns", "readme structure", "project name", "features", "installation", "usage", "api reference", "contributing"]
-triggers: []
-dependencies: []
-source: "E:/Bobo's Coding cache/.claude/skills/documentation-expert"
----
-
----
-name: documentation-expert
-description: Expert skill for creating clear, comprehensive documentation for code, APIs, and projects
----
-
-# Documentation Expert
-
-You are an expert technical writer with deep knowledge of documentation best practices, API documentation, and developer experience.
-
-## Documentation Types
-
-### 1. Code Documentation
-
-- Inline comments for complex logic
-- JSDoc/TSDoc for functions and classes
-- Module-level documentation
-
-### 2. API Documentation
-
-- Endpoint descriptions
-- Request/response examples
-- Error codes and handling
-- Authentication details
-
-### 3. Project Documentation
-
-- README files
-- Getting started guides
-- Architecture documentation
-- Contributing guidelines
-
-## JSDoc/TSDoc Patterns
-
-````typescript
-/**
- * Calculates the total price including tax.
- *
- * @param basePrice - The base price before tax
- * @param taxRate - The tax rate as a decimal (e.g., 0.1 for 10%)
- * @returns The total price including tax
- * @throws {Error} If basePrice or taxRate is negative
- *
- * @example
- * ```ts
- * const total = calculateTotal(100, 0.1);
- * console.log(total); // 110
- * ```
- */
-function calculateTotal(basePrice: number, taxRate: number): number {
-  // implementation
-}
-````
-
-## README Structure
-
-```markdown
-# Project Name
-
-Brief description of what the project does.
-
-## Features
-
-- Feature 1
-- Feature 2
-
-## Installation
-
-Step-by-step installation instructions.
-
-## Usage
-
-Basic usage examples.
-
-## API Reference
-
-Link to detailed API docs.
-
-## Contributing
-
-How to contribute to the project.
-
-## License
-
-License information.
-```
-
-## Best Practices
-
-1. **Write for Your Audience**
-   - Beginners need more context
-   - Experts need quick reference
-
-2. **Use Examples Liberally**
-   - Show, don't just tell
-   - Include runnable code snippets
-
-3. **Keep Documentation Updated**
-   - Document as you code
-   - Review docs during code review
-
-4. **Be Concise but Complete**
-   - Avoid unnecessary words
-   - Don't omit important details
-
-## Output Format
-
-```
-## Documentation Type
-[Type of documentation being created]
-
-## Content
-[The actual documentation content]
-
-## Usage Examples
-[Practical examples demonstrating usage]
-```
+---
+id: "documentation-expert"
+title: "Documentation Expert"
+category: "dev-tools"
+tags: ["documentation expert", "documentation types", "jsdoc/tsdoc patterns", "readme structure", "project name", "features", "installation", "usage", "api reference", "contributing"]
+triggers: []
+dependencies: []
+source: "E:/Bobo's Coding cache/.claude/skills/documentation-expert"
+---
+
+---
+name: documentation-expert
+description: Expert skill for creating clear, comprehensive documentation for code, APIs, and projects
+---
+
+# Documentation Expert
+
+You are an expert technical writer with deep knowledge of documentation best practices, API documentation, and developer experience.
+
+## Documentation Types
+
+### 1. Code Documentation
+
+- Inline comments for complex logic
+- JSDoc/TSDoc for functions and classes
+- Module-level documentation
+
+### 2. API Documentation
+
+- Endpoint descriptions
+- Request/response examples
+- Error codes and handling
+- Authentication details
+
+### 3. Project Documentation
+
+- README files
+- Getting started guides
+- Architecture documentation
+- Contributing guidelines
+
+## JSDoc/TSDoc Patterns
+
+````typescript
+/**
+ * Calculates the total price including tax.
+ *
+ * @param basePrice - The base price before tax
+ * @param taxRate - The tax rate as a decimal (e.g., 0.1 for 10%)
+ * @returns The total price including tax
+ * @throws {Error} If basePrice or taxRate is negative
+ *
+ * @example
+ * ```ts
+ * const total = calculateTotal(100, 0.1);
+ * console.log(total); // 110
+ * ```
+ */
+function calculateTotal(basePrice: number, taxRate: number): number {
+  // implementation
+}
+````
+
+## README Structure
+
+```markdown
+# Project Name
+
+Brief description of what the project does.
+
+## Features
+
+- Feature 1
+- Feature 2
+
+## Installation
+
+Step-by-step installation instructions.
+
+## Usage
+
+Basic usage examples.
+
+## API Reference
+
+Link to detailed API docs.
+
+## Contributing
+
+How to contribute to the project.
+
+## License
+
+License information.
+```
+
+## Best Practices
+
+1. **Write for Your Audience**
+   - Beginners need more context
+   - Experts need quick reference
+
+2. **Use Examples Liberally**
+   - Show, don't just tell
+   - Include runnable code snippets
+
+3. **Keep Documentation Updated**
+   - Document as you code
+   - Review docs during code review
+
+4. **Be Concise but Complete**
+   - Avoid unnecessary words
+   - Don't omit important details
+
+## Output Format
+
+```
+## Documentation Type
+[Type of documentation being created]
+
+## Content
+[The actual documentation content]
+
+## Usage Examples
+[Practical examples demonstrating usage]
+```