Skip to content

luisjguedes/docs-portfolio

Repository files navigation

Docs Portfolio - Luis Guedes da Silva

A public, non-proprietary portfolio showing how I build documentation as a product: information architecture, developer-focused writing, docs-as-code workflows, API documentation, and AI-assisted documentation governance.

Live site: https://luisjguedes.github.io/docs-portfolio/

Recommended portfolio path

  1. docs-portfolio - the front door for documentation samples and working style
  2. docs-ai-operating-model - flagship AI DocsOps project: quality gates, PromptOps, governance, and evaluation for AI-assisted documentation
  3. openapi-to-human-reference - API documentation transformation from OpenAPI contract to human-readable Markdown reference
  4. docsops-quality-gate - reusable PR quality gate for documentation linting, link checks, terminology, and scorecards

Highlights

  • Structured docs: concept, how-to, reference, and troubleshooting patterns
  • Docs-as-code: Markdown + MkDocs Material with CI checks in GitHub Actions
  • Quality guardrails: Microsoft-aligned style linting with Vale
  • AI DocsOps: quality gates, PromptOps, governance, and evaluation model for AI-assisted documentation
  • API documentation sample using OpenAPI (api/openapi.yaml)
  • Diagramming sample using Mermaid

Notes

All content is generic and created for portfolio purposes only. No employer, customer, or confidential material is included.

Contact

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors