Technical Documentation Hub

Documentation method hub for technical writing, project documentation, runbooks, decision records and governance-oriented knowledge management.

This repository collects documentation practices, templates and project documentation references used across infrastructure, DevSecOps, Microsoft identity, operational security and regulated IT portfolio work.

The repository itself is a private working hub. The Vercel site is a public-safe static preview of selected documentation pages, not a public mirror of all private material.

The purpose is not to act as a public CV. The purpose is to make technical knowledge reusable, transferable and reviewable.

Purpose

Technical documentation is not only a description written after the work is done.

In operational and regulated environments, documentation is part of the control system:

Can another person understand the system?
Can a decision be reviewed later?
Can a change be traced?
Can an incident be reconstructed?
Can a handover happen without tribal knowledge?
Can evidence be separated from private customer data?

This repository is a central place for those patterns.

Scope

This hub covers:

• GitBook-style structured documentation
• GitLab/GitHub Markdown documentation
• Obsidian-style knowledge base structure
• project README patterns
• runbooks and operational notes
• decision records
• incident notes
• portfolio project documentation indexes
• project documentation cards
• portfolio spine roadmap and reading guidance
• cybersecurity governance perspective
• identity security and Active Directory perspective
• AI agent authority boundary governance
• public/private documentation boundaries
• audit and evidence-oriented writing
• Microsoft identity and Active Directory troubleshooting documentation
• lightweight documentation quality gate validation
• public-safe static documentation previewing

Repository structure

.github/workflows/
  documentation-quality-gate.yml

docs/
  AI_AGENT_ACCESS_BOUNDARIES_DEVSECOPS_GOVERNANCE.md
  CYBERSECURITY_GOVERNANCE_PERSPECTIVE.md
  DOCUMENTATION_PRINCIPLES.md
  DOCUMENTATION_QUALITY_GATE.md
  ESP32_GATEHOUSE_QUALITY_GATE_CASE_STUDY.md
  IDENTITY_SECURITY_ACTIVE_DIRECTORY_PERSPECTIVE.md
  KNOWLEDGE_BASE_STRUCTURE.md
  LIGHTHOUSE_STATIC_PREVIEW_AUDIT_2026-06-23.md
  OBSIDIAN_STYLE_WORKFLOW.md
  PORTFOLIO_CODE_REPOSITORY_AUDIT_2026-06-23.md
  PROJECT_DOCUMENTATION_INDEX.md
  PORTFOLIO_NARRATIVE.md
  PORTFOLIO_SPINE_ROADMAP.md
  PUBLIC_STATIC_PREVIEW_BOUNDARY.md
  QUALITY_GATE_ARCHITECTURE_DECISION.md
  RBAC_LITE_LOCAL_DOCKER_ENVIRONMENT_CASE_STUDY.md
  TECHNICAL_DOCUMENTATION_DEPLOYMENT_RECOVERY_SUMMARY_2026-06-23.md
  VERCEL_AI_GATEWAY_LOCAL_TEXT_GENERATION_TEST.md
  VERCEL_RECOVERY_CODES_HANDLING_NOTE.md
  active-directory/
    README.md
    ad-ds-troubleshooting-guide.md
    ad-ds-command-reference.md
    ad-ds-interview-notes.md
    evidence/
      applied-skills-ad-ds-2026-05.md

tools/
  build-vercel-static-site.mjs
  validate_documentation_quality.py

templates/
  technical-note-template.md
  decision-record-template.md

indexes/
  portfolio-projects.md
  project-summaries.md

projects/
  gatehouse.md
  esp32-iot-security-governance-lab.md
  rbac-lite.md
  sadepois.md
  local-first-wordpress-devsecops-kit.md
  ai-itsm-compliance-auto.md
  oaas-governance-note.md
  haas.md

Key indexes and narratives

Project documentation cards

Knowledge sections

Static preview

This repository can be rendered as a lightweight public-safe static documentation preview through Vercel.

The preview is generated by:

npm run vercel-build

The related configuration is:

vercel.json
package.json
tools/build-vercel-static-site.mjs

The static preview is not a production documentation platform. It is a selected, sanitized preview layer.

Quality gate

This repository includes a lightweight documentation quality gate:

python tools/validate_documentation_quality.py

The related GitHub Actions workflow is:

.github/workflows/documentation-quality-gate.yml

The gate checks for documentation hygiene issues such as accidental credential identifiers, private key material, unscoped production-readiness claims and missing documentation boundary sections.

Documentation principles

This repository follows a few simple principles:

1. Documentation should reduce operational ambiguity.

2. Documentation should make ownership and responsibility visible.

3. Documentation should separate public examples from private evidence.

4. Documentation should support handover, auditability and review.

5. Documentation should not overclaim project maturity.

6. Documentation should preserve the boundary between learning, portfolio work and production systems.

7. Public previews should contain only sanitized, public-safe material.

Portfolio documentation role

This hub can reference portfolio repositories, but it should not replace their own README files.

Each project should keep its own local documentation, while this repository acts as an index and method library.

Examples of documentation themes:

What this is not

This repository is not:

• a production documentation repository
• a customer evidence archive
• a public storage location for private material
• a certification claim
• a replacement for project-specific documentation
• a marketing-first portfolio site
• a public mirror of all private notes

It is a working documentation hub with a public-safe static preview layer.

One-sentence summary

This repository organizes how technical knowledge is written, linked, reviewed, previewed and transferred across infrastructure, DevSecOps and regulated IT work.

Published documentation pages

• Documentation Quality Gate
• Quality Gate Architecture Decision
• Portfolio Narrative
• Portfolio Spine Roadmap
• Cybersecurity Governance Perspective
• Identity Security and Active Directory Perspective
• AI Agent Authority Boundaries in DevSecOps Workflows
• Portfolio Code Repository Audit 2026-06-23
• Public Static Preview Boundary
• Deployment Recovery Summary 2026-06-23
• Lighthouse Static Preview Audit 2026-06-23
• Vercel Recovery Codes Handling Note
• Vercel AI Gateway Local Text Generation Test
• RBAC-Lite Local Docker Environment Case Study
• ESP32 Gatehouse Quality Gate Case Study
• AD DS Troubleshooting Guide
• AD DS Command Reference