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

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

title	description	template	version	last_updated	author	tags	categories	difficulty	prerequisites	related_docs	dependencies	llm_context	search_keywords
[DOCUMENT TITLE]	[Brief description of the document's purpose and scope]	TEMPLATE.documentation-standard	1.0.0	[YYYY-MM-DD]	[Document Author]	[tag1] [tag2] [tag3]	[category1] [category2]	intermediate	[prerequisite1] [prerequisite2]	[related-doc1.md] [related-doc2.md]	[required-file1] [required-directory/]	high	[keyword1] [keyword2] [keyword3]

[DOCUMENT TITLE]

Purpose

[Brief 2-3 sentence description of what this document is for and who should use it. Be specific about the document's scope and intended audience.]

When to Use

[Clear list of scenarios when this document should be referenced. Include specific triggers, situations, or conditions that warrant consulting this documentation.]

• Primary Use Case: [Main reason to use this document]
• Secondary Use Cases: [Additional scenarios]
• Edge Cases: [Special circumstances]
• Avoid When: [When NOT to use this document]

How to Use

[Step-by-step instructions for applying the information in this document. Include specific commands, procedures, or workflows that users should follow.]

Quick Start

# Essential commands or steps
[Provide working examples]

Prerequisites

• [List any requirements or dependencies]
• [Include system requirements if applicable]

Step-by-Step Process

1. [Step 1]: [Description and command]
2. [Step 2]: [Description and command]
3. [Continue as needed]

What It Is

[Comprehensive technical documentation that explains the system, process, or concept in detail. This is the "meat and potatoes" section that provides deep technical understanding.]

Architecture Overview

[High-level system design, components, and relationships]

Technical Details

[Detailed explanation of how the system works, including:]

• Core Components: [Key parts and their functions]
• Data Flow: [How information moves through the system]
• Dependencies: [What the system relies on]
• Configuration: [How to configure the system]

Implementation Details

[Specific technical implementation information:]

• File Structure: [Relevant files and directories]
• Code Examples: [Working code samples with context]
• Configuration Options: [Available settings and their effects]
• Integration Points: [How this connects with other systems]

Advanced Topics

[Complex or specialized information for advanced users:]

• Customization: [How to modify or extend the system]
• Performance Considerations: [Optimization and scaling]
• Security Implications: [Security considerations and best practices]

Troubleshooting

FAQ

Q: [Common question about the topic] A: [Clear, concise answer with specific steps if applicable]

Q: [Another common question] A: [Answer with examples or references to other sections]

Q: [Continue with up to 10 frequently asked questions] A: [Keep answers updated as new issues are discovered]

Command Reference

[Essential commands for troubleshooting and maintenance:]

# [Command description]
[command] [options] [arguments]

# [Another command description]
[command] [options] [arguments]

# [Continue with commonly used commands]

Common Issues and Solutions

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

Debugging Steps

1. [Check X]: [How to verify this component]
2. [Check Y]: [How to verify this component]
3. [Check Z]: [How to verify this component]

Log Analysis

[How to read and interpret relevant logs:]

# [Command to view logs]
[command] | grep [pattern]

# [What to look for in logs]
[explanation of log patterns and their meanings]

Performance Troubleshooting

[Specific guidance for performance-related issues:]

• Resource Usage: [How to check CPU, memory, disk usage]
• Bottlenecks: [Common performance bottlenecks and solutions]
• Monitoring: [How to monitor system health]

Lessons Learned

YYYY-MM-DD: [Description of what was learned, what problem it solved, and how it improves the documentation]

YYYY-MM-DD: [Another lesson learned with timestamp]

[Continue adding lessons learned entries as new insights are gained]

Related Documentation

[Links to related documents and their relationships:]

• [Related Doc 1]: [Brief description of relationship]
• [Related Doc 2]: [Brief description of relationship]
• [Related Doc 3]: [Brief description of relationship]

LLM Context

[Additional context specifically for Large Language Models:]

• Key Concepts: [Important concepts for AI understanding]
• Technical Context: [Technical background information]
• Common Patterns: [Frequently used patterns or approaches]
• Edge Cases: [Important edge cases to consider]
• Integration Points: [How this relates to other systems]

---

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