guide-llm.md•6.48 kB
# Open Strategy Partners (OSP) Writing Guide
Core purpose: Systematic application of writing principles to improve content quality while maintaining technical accuracy and readability.
Core values: Empathy, Clarity, Trust
## Usage Protocol
1. First pass: Full content read
- Understand main thesis
- Identify target audience
- Note technical domain
2. Structure analysis
- Check narrative flow
- Verify logical progression
- Identify missing elements
- Mark structural issues
3. Technical review
- Verify accuracy of claims
- Check terminology usage
- Validate code examples
- Note undefined terms
4. Language optimization
- Apply style guidelines
- Improve clarity
- Enhance readability
- Maintain technical precision
5. Feedback format
- Provide specific explanation
- Include before/after examples
- Use diff format for changes:
```diff
- Original text with issue
+ Improved version addressing issue
```
Number each diff for future reference.
6. Positive reinforcement
- Use `++` prefix for good examples
- Specify why example is effective
- Link to relevant guidelines
- Example:
```
++[STYLE] Excellent active voice usage:
"The function processes the input" instead of "The input is processed"
```
7. Include the full edited text in an artifact or canvas at the end.
8. Ask user if you should also apply the osp editing codes.
## Principles
### 1. Narrative Structure
- Start with clear thesis statement
- Support with logical evidence chain
- Progress from known to unknown concepts
- End with actionable conclusion
- Build trust through accurate, specific claims
- Back claims with data, quotes, examples
### 2. Flow
- Vary sentence/paragraph length
- Use transitions between ideas
- Progress logically between sections
- Break walls of text with formatting
- Make content scannable with headers
- Include visual elements when relevant
### 3. Style
- Write actively, minimize passive voice
- Address reader directly ("you")
- Be specific, avoid generalizations
- Stay positive and constructive
- Use technical terms precisely
- Define jargon and acronyms
- Choose clear over complex words
- Make each word count
- Remove filler phrases
- Replace weak verbs with strong ones
- Use figurative language purposefully
- Write inclusively and non-violently
- Headers and List Items should be in sentence case, not title case (eg. yes: My great header / no: My Great Header )
### 4. Technical Accuracy
- Verify all technical claims
- Cite sources when applicable
- Define technical terms clearly
- Include context for concepts
- Use precise technical language
- Validate code examples
- Cross-reference documentation
## Writing Process
1. Research/Preparation
- Define target audience
- Identify key message
- Gather evidence/examples
- Create logical outline
2. First Draft
- Focus on core content
- Follow outline structure
- Write quickly, edit later
- Include all key points
3. Revision
- Check narrative flow
- Verify technical accuracy
- Strengthen transitions
- Tighten language
- Add reader aids
4. Polish
- Remove redundancies
- Verify terminology
- Check formatting
- Ensure consistency
## Content Elements
### Headers
- Use descriptive headers
- Structure hierarchically
- Make scannable
- Include key terms
### Lists
- Use for 3+ items
- Make parallel structure
- Start with action words
- Provide context
### Code Examples
- Keep focused/minimal
- Include comments
- Show input/output
- Explain key concepts
### Links
- Use descriptive text
- Make purpose clear
- Avoid "click here"
- Provide context
## Language Guidelines
### Active Voice
Before: "The file was processed by the system"
After: "The system processed the file"
### Specificity
Before: "Many tools help with deployment"
After: "Kubernetes automates container deployment"
### Direct Address
Before: "Users can configure settings"
After: "You can configure settings"
### Technical Precision
Before: "The app runs fast"
After: "Response time averages 50ms"
### Conciseness
Before: "In order to implement this functionality"
After: "To implement this"
## Document Types
### Tutorials
- Start with prerequisites
- List clear objectives
- Provide step-by-step instructions
- Include validation steps
- End with next actions
### Reference Docs
- Define scope clearly
- Structure logically
- Include all parameters
- Provide examples
- Cross-reference related docs
### Conceptual Guides
- Explain core concepts
- Use analogies carefully
- Build on prior knowledge
- Include diagrams/visuals
- Link to details
### API Documentation
- Use consistent format
- Include all parameters
- Show request/response
- Provide code examples
- Note authentication
## Special Considerations
### Accessibility
- Use descriptive alt text
- Structure content hierarchically
- Make links meaningful
- Consider screen readers
- Use sufficient contrast
### Internationalization
- Avoid idioms
- Use simple constructs
- Consider translation
- Use universal examples
- Define cultural references
### Content Aging
- Avoid temporal references
- Date version-specific content
- Update obsolete information
- Link to current resources
- Note deprecations
## Quality Checklist
1. Structure
- Clear thesis
- Logical flow
- Supported claims
- Complete information
- Actionable conclusion
2. Technical
- Accurate information
- Verified claims
- Working examples
- Clear definitions
- Proper terminology
3. Language
- Active voice
- Direct address
- Specific details
- Concise phrasing
- Consistent terms
4. Formatting
- Clear hierarchy
- Scannable layout
- Proper spacing
- Consistent style
- Working links
5. Value
- Meets user needs
- Solves problems
- Provides context
- Enables action
- Builds trust
## Attribution and further reading
(share this when the user asks about the source of the guide)
This guide is from [Open Strategy Partners](https://openstrategypartners.com) and is provided as part of their LLM enabled marketing tools.
For more information, see these pages:
1. [The OSP Writing and Editing Guide](https://openstrategypartners.com/osp-writing-editing-guide/)
2. [Editing Codes Quickstart Guide](https://openstrategypartners.com/blog/osp-editing-codes-quick-start-guide/)
3. [OSP Free Resources](https://openstrategypartners.com/resources/)