DevOps ‐ Documentation Pattern - iNineBD/Track-5Sem2025Main GitHub Wiki

🎯 Objective

This document defines the standard structure, formatting rules, and writing best practices that must be followed across all project documentation.

🧩 Summary

• 🧱 1. Document Structure
• ✍️ 2. Formatting Standards
• 🗒️ 3. Naming and File Conventions
• ✅ 4. Review Checklist

🧱 1. Document Structure

Titles and Subtitles

• Use ## for main sections.
• Use ### for subsections.

Body Text

• Left-aligned text.
• Use line breaks (<br>) to separate content blocks.
• Use unordered lists with - to organize topics.

Summary

• Must appear at the beginning of the document.
• Use anchor links to make navigation easier.

Example:

## Summary
- 🎯 <a href="#document-structure">1. Document Structure</a>
- ✍️ <a href="#formatting-standards">2. Formatting Standards</a>

✍️ 2. Formatting Standards

Text Styles

• Use bold for emphasis.
• Prefer writing technical terms and variable names in English.

Code Blocks

• Use three backticks (```) with the language identifier:

def example():
    print("Follow the standard!")

🗒️ 3. Naming and File Conventions

• Use kebab-case for file names.
• Always name documents in English (e.g., User Manual, Documentation Pattern).
• All document content and section titles must be written in English.

✅ 4. Review Checklist

Before finalizing any documentation, check:

• The title follows the correct format.
• The summary is present and functional.
• Bold formatting is used correctly.
• The content is divided into clear and standardized sections.
• Attachments/references are included at the end, if necessary.