Files
smom-dbis-138/docs/templates/NEW_GUIDE_TEMPLATE.md

71 lines
1.2 KiB
Markdown

# Guide Title
**Last Updated**: YYYY-MM-DD
**Status**: Active
**Purpose**: Brief description of what this guide covers
## Table of Contents
- [Overview](#overview)
- [Prerequisites](#prerequisites)
- [Section 1](#section-1)
- [Section 2](#section-2)
- [Troubleshooting](#troubleshooting)
- [Related Documentation](#related-documentation)
## Overview
Brief overview of what this guide covers and when to use it.
> **Related Documentation**:
> - [Related Guide 1] (path/to/guide1.md) - Description
> - [Related Guide 2] (path/to/guide2.md) - Description
## Prerequisites
List all prerequisites:
- Prerequisite 1
- Prerequisite 2
- Prerequisite 3
## Section 1
Content for section 1.
### Subsection 1.1
Content for subsection.
```bash
# Example command
command --option value
```
## Section 2
Content for section 2.
## Troubleshooting
### Common Issue 1
**Symptoms**: Description of issue
**Solution**: Steps to resolve
```bash
# Troubleshooting command
troubleshoot-command
```
## Related Documentation
- [Master Documentation Index](../MASTER_DOCUMENTATION_INDEX.md)
- [Style Guide](../governance/DOCUMENTATION_STYLE_GUIDE.md)
---
**Last Updated**: YYYY-MM-DD
**Next Review**: YYYY-MM-DD