Documentation Guidelines

Guidelines for contributing to SCF documentation.

Style Guide

We follow the WordPress Documentation Style Guide:

1. Voice and Tone
   • Clear and concise
   • Professional but friendly
   • Internationally accessible
   • Gender-neutral language
2. Formatting
   • Use Markdown
   • Follow heading hierarchy
   • Include code examples
   • Use proper spacing
3. Content Structure
   • Start with overview
   • Include examples
   • Provide context
   • Link related topics

Documentation Types

1. User Documentation
   • Installation guides
   • Usage instructions
   • UI explanations
   • Troubleshooting
2. Developer Documentation
   • API reference
   • Hook documentation
   • Integration guides
   • Security practices