LeafMove Documentation CenterLeafMove Documentation Center
Home
Guide
API Docs
LeafMove Official
  • 简体中文
  • English
GitHub
Home
Guide
API Docs
LeafMove Official
  • 简体中文
  • English
GitHub
  • 📖 User Guide

    • User Guide
    • Getting Started
    • Configuration Guide
    • Deployment Guide
    • Content Creation Guide
    • Troubleshooting Guide
  • 🔧 API Docs

    • API Documentation
    • API Authentication Guide
    • API Usage Examples
    • Error Codes Reference

AutoBox Prompt Library

A comprehensive collection of AI prompts for various documentation tasks. These prompts are designed to help you generate high-quality content efficiently.

📝 Content Generation Prompts

API Documentation

Generate comprehensive API documentation for the following endpoint:

**Endpoint Information:**
- Method: [HTTP_METHOD]
- Path: [API_PATH]
- Description: [BRIEF_DESCRIPTION]
- Parameters: [PARAMETER_LIST]

**Requirements:**
1. Include complete parameter tables
2. Provide code examples in multiple languages
3. Add error handling examples
4. Include authentication details
5. Use clear, professional language

Please generate detailed API documentation following REST API best practices.

User Guide Creation

Create a user-friendly guide for the following feature:

**Feature Information:**
- Feature Name: [FEATURE_NAME]
- Target Users: [USER_TYPE]
- Use Cases: [SCENARIOS]
- Key Functions: [FUNCTION_LIST]

**Output Requirements:**
1. Step-by-step instructions
2. Screenshots placeholders
3. Common troubleshooting tips
4. Related features section
5. Next steps recommendations

Write in a clear, beginner-friendly tone with practical examples.

Technical Tutorial

Develop a comprehensive tutorial for:

**Topic:** [TUTORIAL_TOPIC]
**Skill Level:** [BEGINNER/INTERMEDIATE/ADVANCED]
**Duration:** [ESTIMATED_TIME]
**Prerequisites:** [REQUIRED_KNOWLEDGE]

**Structure Requirements:**
1. Learning objectives
2. Prerequisites check
3. Step-by-step instructions
4. Code examples with explanations
5. Practice exercises
6. Summary and next steps

Focus on hands-on learning with practical examples.

🔧 Content Optimization Prompts

Readability Improvement

Improve the readability and clarity of the following content:

**Original Content:**
[PASTE_CONTENT_HERE]

**Optimization Goals:**
1. Simplify complex sentences
2. Improve paragraph structure
3. Add clear headings and subheadings
4. Enhance flow and transitions
5. Maintain technical accuracy

**Target Audience:** [AUDIENCE_DESCRIPTION]

Please rewrite for better clarity while preserving all technical information.

SEO Optimization

Optimize the following content for search engines:

**Content:** [CONTENT_TO_OPTIMIZE]
**Primary Keywords:** [KEYWORD_LIST]
**Target Audience:** [AUDIENCE_TYPE]

**SEO Requirements:**
1. Natural keyword integration
2. Compelling meta descriptions
3. Proper heading hierarchy (H1, H2, H3)
4. Internal linking suggestions
5. Content structure optimization

Maintain readability while improving search visibility.

Content Restructuring

Restructure the following content for better organization:

**Current Content:** [EXISTING_CONTENT]

**Restructuring Goals:**
1. Logical information hierarchy
2. Improved scanability
3. Better section organization
4. Clear navigation flow
5. Enhanced user experience

**Output Format:** [DESIRED_FORMAT]

Reorganize while maintaining all important information.

📊 Analysis and Review Prompts

Content Quality Assessment

Analyze the quality of the following documentation:

**Content to Review:** [CONTENT_HERE]

**Assessment Criteria:**
1. Clarity and readability
2. Completeness and accuracy
3. Structure and organization
4. User-friendliness
5. Technical correctness

**Provide:**
- Overall quality score (1-10)
- Specific improvement recommendations
- Priority areas for enhancement
- Strengths to maintain

Include actionable suggestions for improvement.

Gap Analysis

Identify content gaps in the following documentation:

**Current Documentation:** [DOCUMENTATION_OVERVIEW]
**Target Audience:** [USER_GROUPS]
**Use Cases:** [SCENARIOS]

**Analysis Focus:**
1. Missing information
2. Incomplete sections
3. User journey gaps
4. Technical coverage holes
5. Support material needs

Provide a prioritized list of content to create or improve.

🎨 Creative Content Prompts

FAQ Generation

Generate a comprehensive FAQ section for:

**Topic:** [SUBJECT_AREA]
**Common Issues:** [KNOWN_PROBLEMS]
**User Feedback:** [USER_QUESTIONS]

**FAQ Requirements:**
1. 10-15 most common questions
2. Clear, concise answers
3. Logical categorization
4. Troubleshooting steps where applicable
5. Links to detailed documentation

Focus on real user pain points and practical solutions.

Example Creation

Create practical examples for:

**Concept:** [CONCEPT_TO_ILLUSTRATE]
**Complexity Level:** [SIMPLE/MODERATE/COMPLEX]
**Context:** [USE_CASE_SCENARIO]

**Example Requirements:**
1. Real-world relevance
2. Step-by-step breakdown
3. Expected outcomes
4. Common variations
5. Error scenarios

Make examples relatable and easy to follow.

🔄 Translation and Localization

Content Translation

Translate the following content while maintaining technical accuracy:

**Source Language:** [SOURCE_LANG]
**Target Language:** [TARGET_LANG]
**Content Type:** [DOCUMENTATION_TYPE]

**Content:** [CONTENT_TO_TRANSLATE]

**Translation Requirements:**
1. Preserve technical terminology
2. Maintain formatting and structure
3. Adapt cultural references
4. Ensure natural language flow
5. Keep consistent tone

Focus on accuracy and cultural appropriateness.

Localization Adaptation

Adapt the following content for [TARGET_REGION]:

**Original Content:** [CONTENT_HERE]
**Target Market:** [REGION/COUNTRY]
**Local Considerations:** [CULTURAL_FACTORS]

**Localization Needs:**
1. Cultural sensitivity
2. Local regulations compliance
3. Regional preferences
4. Currency and units
5. Contact information

Ensure content resonates with local audience.

🛠 Specialized Prompts

Code Documentation

Generate documentation for the following code:

**Programming Language:** [LANGUAGE]
**Code Type:** [FUNCTION/CLASS/MODULE]
**Code:** [CODE_SNIPPET]

**Documentation Requirements:**
1. Purpose and functionality
2. Parameter descriptions
3. Return value details
4. Usage examples
5. Error conditions
6. Dependencies

Follow standard documentation conventions for [LANGUAGE].

Process Documentation

Document the following business process:

**Process Name:** [PROCESS_TITLE]
**Stakeholders:** [INVOLVED_PARTIES]
**Inputs:** [REQUIRED_INPUTS]
**Outputs:** [EXPECTED_OUTPUTS]

**Documentation Structure:**
1. Process overview
2. Step-by-step procedures
3. Roles and responsibilities
4. Decision points
5. Exception handling
6. Success criteria

Create clear, actionable process documentation.

💡 Tips for Using Prompts

Best Practices

  1. Be Specific: Provide detailed context and requirements
  2. Set Clear Goals: Define what you want to achieve
  3. Include Examples: Show the desired output format
  4. Iterate: Refine prompts based on results
  5. Customize: Adapt prompts to your specific needs

Prompt Optimization

  • Use clear, specific language
  • Provide relevant context
  • Set appropriate constraints
  • Include quality criteria
  • Specify output format

Common Mistakes to Avoid

  • Vague or ambiguous instructions
  • Missing context information
  • Unrealistic expectations
  • Overly complex requests
  • Insufficient detail

🔗 Related Resources

  • Usage Guide - Learn how to use these prompts effectively
  • Best Practices - Expert tips for AI-assisted documentation
  • Case Studies - Real-world examples and results

Ready to get started? Choose a prompt that matches your needs and customize it for your specific use case!

Edit this page on GitHub