siriusscan--sirius/documentation/dev/templates/TEMPLATE.guide.md

title, description, template, version, last_updated, author, tags, categories, difficulty, prerequisites, related_docs, dependencies, llm_context, search_keywords, estimated_time

title	description	template	version	last_updated	author	tags	categories	difficulty	prerequisites	related_docs	dependencies	llm_context	search_keywords	estimated_time
[GUIDE TITLE]	[Brief description of the step-by-step guide]	TEMPLATE.guide	1.0.0	[YYYY-MM-DD]	[Guide Author]	[tag1] [tag2] [tag3]	[category1] [category2]	intermediate	[prerequisite1] [prerequisite2]	[related-doc1.md] [related-doc2.md]	[required-file1] [required-directory/]	medium	[keyword1] [keyword2] [keyword3]	[X minutes|hours]

[GUIDE TITLE]

Purpose

[Brief description of what this guide accomplishes and who should follow it. Focus on the end result or goal.]

When to Use This Guide

[Specific scenarios when this guide should be followed:]

• Primary Scenario: [Main use case for this guide]
• Alternative Scenarios: [Other situations where this applies]
• Prerequisites Met: [When you have the required knowledge/tools]

How to Use This Guide

[Instructions for following the guide effectively:]

• Read through completely before starting
• Gather prerequisites listed below
• Follow steps in order unless noted otherwise
• Verify each step before proceeding to the next

Quick Start

# Essential commands to get started
[Provide working examples]

Prerequisites

Knowledge Required:

• [Required knowledge or skills]
• [Familiarity with specific tools]

Tools Required:

• [Required software or tools]
• [System requirements]

Access Required:

• [Required permissions or access]
• [Required accounts or credentials]

Step-by-Step Instructions

Step 1: [Step Title]

Objective: [What this step accomplishes]

Instructions:

1. [Detailed instruction]
2. [Next instruction]
3. [Continue as needed]

Verification:

# Command to verify this step worked
[verification command]

Expected Output:

[Expected output or result]

Troubleshooting:

• If X happens: [Solution]
• If Y happens: [Solution]

Step 2: [Step Title]

[Continue with detailed steps...]

Step 3: [Step Title]

[Continue with detailed steps...]

Verification and Testing

Final Verification

[How to verify the entire process worked correctly:]

# Commands to verify everything is working
[verification commands]

Testing Checklist

• [Test item 1]
• [Test item 2]
• [Test item 3]
• [Continue as needed]

Common Variations

Variation 1: [Scenario Name]

[When to use this variation and how it differs:]

Additional Steps:

1. [Additional step]
2. [Another additional step]

Skip These Steps:

• [Step to skip]
• [Another step to skip]

Variation 2: [Scenario Name]

[Another common variation...]

Troubleshooting

FAQ

Q: What if Step X fails? A: [Detailed solution with steps]

Q: How do I know if I'm on the right track? A: [How to verify progress]

Q: Can I skip Step Y? A: [When it's safe to skip and what to do instead]

Q: What if I get error message Z? A: [Specific error resolution]

Common Issues and Solutions

Issue	Symptoms	Solution
[Common problem 1]	[How to identify]	[Step-by-step fix]
[Common problem 2]	[How to identify]	[Step-by-step fix]
[Continue as needed]	[Continue as needed]	[Continue as needed]

Rollback Instructions

[How to undo the changes if something goes wrong:]

1. [Rollback Step 1]: [How to undo this step]
2. [Rollback Step 2]: [How to undo this step]
3. [Continue as needed]: [Continue rollback steps]

Getting Help

If you're stuck:

1. Check the troubleshooting section above
2. Review the prerequisites
3. Verify you followed each step exactly
4. Check the related documentation
5. [Contact information or escalation path]

Advanced Topics

Customization Options

[How to customize the process for specific needs:]

• Option A: [Description and how to implement]
• Option B: [Description and how to implement]

Performance Optimization

[Tips for making the process faster or more efficient:]

• [Optimization tip 1]
• [Optimization tip 2]

Integration with Other Systems

[How this process integrates with other workflows:]

• [Integration point 1]
• [Integration point 2]

Related Documentation

[Links to related guides and documentation:]

• [Related Guide 1]: [Brief description of relationship]
• [Related Guide 2]: [Brief description of relationship]
• [Reference Doc]: [Technical reference for this topic]

LLM Context

[Additional context for Large Language Models:]

• Process Overview: [High-level process description]
• Key Decision Points: [Important choices in the process]
• Common Pitfalls: [Frequent mistakes to avoid]
• Success Criteria: [How to know the process succeeded]
• Integration Points: [How this connects to other systems]

---

This document follows the Sirius Documentation Standard. For questions about documentation structure, see ABOUT.documentation.md.