Skip to content

Latest commit

 

History

History
225 lines (189 loc) · 7.88 KB

File metadata and controls

225 lines (189 loc) · 7.88 KB

Documentation Tips Extraction Checklist

Instructions

This checklist is designed to systematically extract useful tips from the MaxsAiStudio README documentation and convert them into tip-of-the-day entries for the AiStudio4/Data/tips.json file.

ENORMOUSLY IMPORTANT

All tips must be in the SECOND PERSON IMPERATIVE. All tips must be useful, not just promotional.

Current Tips Format

Each tip follows this JSON structure:

{
  "Id": "tip-XXX",
  "Tip": "Brief, actionable tip text",
  "SamplePrompt": "Optional sample user prompt if applicable"
}

Tip Creation Guidelines

  1. Keep tips concise - Maximum 2-3 sentences
  2. Make tips actionable - Focus on what users can do
  3. Include sample prompts sparingly - Only when they directly demonstrate the tip
  4. Focus on user benefits - What value does this provide?
  5. Use clear, friendly language - Avoid technical jargon when possible
  6. Generate unique IDs - Use sequential numbering (tip-002, tip-003, etc.)

Target Audience

  • New users discovering features
  • Experienced users learning advanced techniques
  • Users who might miss hidden functionality

Main Documentation Files

✅ Core Documentation

  • readme.md - Main README file
  • docs/readme/01-introduction.md - Project introduction and overview
  • docs/readme/02-getting-started.md - Installation and initial setup
  • docs/readme/03-core-concepts.md - Fundamental concepts
  • docs/readme/04-using-aistudio4.md - Basic usage instructions
  • docs/readme/05-key-features-in-detail.md - Detailed feature explanations
  • docs/readme/06-advanced-configuration.md - Advanced setup and configuration
  • docs/readme/07-troubleshooting.md - Common issues and solutions
  • docs/readme/08-technical-stack.md - Technical implementation details
  • docs/readme/09-contributing.md - Contributing guidelines
  • docs/readme/FrontendBestPractices.md - Frontend development guidelines
  • docs/readme/wiki-sync-examples.md - Wiki synchronization examples

✅ Tool Documentation (docs/readme/tools/)

  • Azure DevOps Tools (15 files)

    • azure-dev-ops-get-commit-diffs-tool.md
    • azure-dev-ops-get-commits-tool.md
    • azure-dev-ops-get-item-content-tool.md
    • azure-dev-ops-get-pipeline-definitions-tool.md
    • azure-dev-ops-get-pipeline-resources-tool.md
    • azure-dev-ops-get-pipeline-runs-tool.md
    • azure-dev-ops-get-pull-request-by-id-tool.md
    • azure-dev-ops-get-pull-request-changes-tool.md
    • azure-dev-ops-get-pull-request-iterations-tool.md
    • azure-dev-ops-get-pull-request-threads-tool.md
    • azure-dev-ops-get-pull-requests-tool.md
    • azure-dev-ops-get-repositories-tool.md
    • azure-dev-ops-get-wiki-page-content-tool.md
    • azure-dev-ops-get-wiki-pages-tool.md
    • azure-dev-ops-get-work-item-comments-tool.md
    • azure-dev-ops-get-work-item-updates-tool.md
    • azure-dev-ops-get-work-items-tool.md
    • azure-dev-ops-query-work-items-tool.md
    • azure-dev-ops-search-wiki-tool.md
  • File Management Tools (9 files)

    • create-new-file-tool.md
    • delete-file-tool.md
    • directory-tree-tool.md
    • file-reg-ex-search.md
    • file-search-tool.md
    • find-and-replace-tool.md
    • modify-files-tool.md
    • read-files-tool.md
    • read-partial-files-tool.md
    • rename-file-tool.md
    • replace-file-tool.md
  • Git & GitHub Tools (12 files)

    • git-branch-tool.md
    • git-commit-tool.md
    • git-log-tool.md
    • git-status-tool.md
    • git-hub-create-issue-comment-tool.md
    • git-hub-create-issue-tool.md
    • git-hub-get-content-tool.md
    • git-hub-get-issue-tool.md
    • git-hub-list-contents-tool.md
    • git-hub-list-issue-comments-tool.md
    • git-hub-list-issues-tool.md
    • git-hub-repo-info-tool.md
    • git-hub-search-code-tool.md
    • git-hub-update-issue-tool.md
    • github-create-pull-request-tool.md
    • github-list-pull-requests-tool.md
    • github-update-pull-request-tool.md
  • Search & Web Tools (6 files)

    • gemini-google-search-tool.md
    • google-custom-search-api-tool.md
    • launch-url-tool.md
    • retrieve-text-from-url-tool.md
    • run-duck-duck-go-search-tool.md
    • you-tube-search-tool.md
  • Development Tools (11 files)

    • check-node-version-tool.md
    • get-vite-project-info-tool.md
    • install-vite-plugin-tool.md
    • modify-vite-config-tool.md
    • npm-create-vite-tool.md
    • npm-install-tool.md
    • npm-run-script-tool.md
    • open-browser-tool.md
    • read-database-schema-tool.md
    • sentry-tool.md
    • start-vite-dev-server-tool.md
  • AI Interaction Tools (7 files)

    • info-request-tool.md
    • modify-file-using-morph.md
    • present-results-and-await-user-input-tool.md
    • record-mistake-tool.md
    • second-ai-opinion-tool.md
    • stop-tool.md
    • think-and-await-user-input-tool.md
    • think-and-continue-tool.md

Tip Extraction Process

For each file, follow this process:

1. Read and Analyze

  • Read the entire file carefully
  • Identify key features, shortcuts, best practices
  • Note any "hidden" functionality or non-obvious benefits
  • Look for workflow optimizations

2. Extract Tips

Focus on extracting tips about:

  • Feature Discovery - "Did you know you can..."
  • Workflow Optimization - "Speed up your work by..."
  • Best Practices - "For best results, try..."
  • Hidden Features - "You can also..."
  • Troubleshooting - "If X happens, try Y..."
  • Integration Tips - "Works well with..."

3. Write Tips

For each tip:

  • Create a unique ID (tip-XXX)
  • Write clear, concise tip text
  • Add sample prompt only if it directly demonstrates the tip
  • Ensure tip provides immediate value to users

4. Common Tip Categories to Look For

UI/UX Tips

  • Keyboard shortcuts
  • Context menu options
  • Drag-and-drop functionality
  • Panel management
  • Visual customization options

Feature Tips

  • Tool combinations that work well together
  • Advanced parameters or options
  • File format support
  • Integration capabilities
  • Performance optimization

Workflow Tips

  • Time-saving techniques
  • Automation possibilities
  • Best practices for specific tasks
  • Error prevention
  • Recovery methods

Configuration Tips

  • Setup optimizations
  • Customization options
  • Environment-specific settings
  • Security considerations

Quality Checklist

Before adding tips to the JSON file, ensure each tip meets these criteria:

Content Quality

  • Clear and Concise - Easy to understand in 5 seconds
  • Actionable - User knows exactly what to do
  • Valuable - Provides real benefit to users
  • Accurate - Information is correct and up-to-date
  • Specific - Focuses on one clear concept

Technical Quality

  • Unique ID - No duplicate IDs; ids for tips related to tools should be based in part on the tool name
  • Proper JSON Format - Valid JSON syntax
  • Appropriate Length - Tip text under 200 characters when possible
  • Sample Prompt Relevance - Only included when directly relevant

"ManualReference" should point back to the documentation file being processed for tips, for instance readme.md or docs/readme/01-introduction.md .

User Experience

  • Beginner Friendly - Avoids excessive jargon
  • Contextual - Makes sense without additional explanation
  • Motivating - Encourages users to try the feature
  • Practical - Addresses real user needs

File Location

Tips should be added to: AiStudio4/Data/tips.json. There is no limit on how many tips should be added. All useful distinct tips are worthwhile. Non-tool manual pages should yield between 5 and 20 tips each.