📝 Real-Time Documentation Editing Guide

🎯 How to Get Live Help While Writing

Quick Help Commands

While editing your markdown, you can:

1. Select Text + Ask Questions

• Select any section you're writing/editing
• Ask me: "How can I improve this?"
• I'll see your selection and provide specific suggestions

2. Content Enhancement Requests

• "Make this more professional"
• "Add technical details here"
• "Convert this to a table format"
• "Add code examples"
• "Improve readability"

3. Structure & Formatting Help

• "How should I organize this section?"
• "What markdown features should I use?"
• "Add appropriate callout boxes"
• "Create a better heading structure"

Common Documentation Tasks I Can Help With

✅ Content Writing

You: "Help me write about TCP connection setup"
Me: I'll provide structured content with examples

You: "Make this technical explanation clearer"  
Me: I'll rewrite for better clarity

✅ Formatting & Structure

You: "Format this as a step-by-step guide"
Me: I'll convert to numbered lists with proper markup

You: "Add appropriate callout boxes"
Me: I'll suggest tips, warnings, info boxes

✅ Technical Accuracy

You: "Is this Modbus explanation correct?"
Me: I'll verify and improve technical content

You: "Add missing technical details"
Me: I'll enhance with protocol specifics

✅ User Experience

You: "Make this more user-friendly"
Me: I'll restructure for better UX

You: "Add troubleshooting info"
Me: I'll create problem/solution sections

Best Practices for Real-Time Collaboration

🎯 Be Specific in Requests

• ❌ "Fix this section"
• ✅ "Make this installation guide clearer for beginners"
• ✅ "Add error handling examples to this configuration"

📍 Use Text Selection

• Select the exact text you want help with
• Ask specific questions about that content
• I'll see your selection and provide targeted help

🔄 Iterative Improvement

• Start with basic content
• Ask for enhancements iteratively
• Build up complexity gradually

Example Real-Time Editing Session

YOU WRITE:
## Connection Setup
Set up the connection parameters.

YOU ASK: "Expand this with detailed steps and examples"

I PROVIDE:
## 🔌 Connection Setup

### TCP/IP Configuration

1. **Navigate** to the Client tab
2. **Select Interface**: Choose "TCP" 
3. **Enter IP Address**: Your device IP (e.g., `192.168.1.100`)
4. **Set Port**: Use `502` (standard Modbus port)
5. **Configure Timeout**: Set to `3000ms` for reliable connection

!!! example "Sample Configuration"
    ```yaml
    IP Address: 192.168.1.100
    Port: 502
    Timeout: 3000ms
    Unit ID: 1
    ```

### Troubleshooting Connection Issues
- **Connection Refused**: Check device IP and port
- **Timeout**: Increase timeout value or check network

Specialized Documentation Help

🔧 Technical Writing

• Modbus protocol explanations
• Configuration procedures
• Troubleshooting guides
• API documentation

📊 Visual Elements

• Mermaid diagrams creation
• Table formatting
• Callout box selection
• Code block enhancement

🎨 User Experience

• Navigation flow
• Information architecture
• Readability improvements
• Progressive disclosure

VS Code Integration Tips

Multi-Panel Setup

┌─────────────┬─────────────┬─────────────┐
│  Explorer   │   Editor    │   Preview   │
│             │  (typing)   │  (live)     │
├─────────────┴─────────────┴─────────────┤
│        VS Code Chat (ask questions)     │
└─────────────────────────────────────────┘

Workflow

1. Edit in center panel
2. Preview in right panel
3. Ask questions in chat panel
4. See changes instantly in preview

---

🎯 Ready to Start?

Just begin editing your markdown and ask me questions as you go!

Example questions to get started: - "How should I structure the installation section?" - "Make this configuration table more comprehensive"
- "Add troubleshooting steps for connection errors" - "Convert this paragraph to a step-by-step guide" - "What callout boxes should I use here?"

I'm here to help make your documentation professional, clear, and user-friendly! 🚀 ```