Author Resources

Use these resources while creating, editing, or reviewing service documentation. For step-by-step learning, see Training.

Checklists

• Guide authoring workflow checklist: Follow a shorter, repeatable path from branch setup through review after completing the Beginner’s Guide.
• Guide content checklist: Confirm that a troubleshooting topic is complete and ready for a pull request.
• PR readiness checklist: Confirm that a pull request is ready for review.
• PR review checklist: Check troubleshooting guide content and rendered flow during review.

Examples and Terminology

• Gold Standard Topics: Review examples and qualities of strong troubleshooting topics.
• Glossary: Look up Git, GitHub, and service_docs terms used throughout the authoring material.