Padrão Oficial de Documentação¶

Objetivo¶

Este documento define o padrão oficial para toda a documentação produzida pela HauxTech Soluções.

Aplica-se a:

CoreFlow Platform
CoreFlow CRM
CoreFlow ERP
CoreFlow Finance
CoreFlow BI
CoreFlow AI
CoreFlow RH
CoreFlow WMS
Monitor RPA
Projetos futuros

Princípios¶

Toda documentação deverá ser:

Modular
Versionada
Auditável
Reutilizável
Pesquisável
Preparada para IA
Preparada para Git
Preparada para MkDocs
Preparada para Docusaurus

Organização¶

Um arquivo deve documentar apenas um assunto.

Nunca criar arquivos gigantes contendo dezenas de assuntos diferentes.

Exemplo correto:

crm/

leads.md
contacts.md
accounts.md
pipeline.md
opportunities.md

Exemplo incorreto:

crm.md

Front Matter¶

Todo documento deverá iniciar com:

---
title:
description:
product:
module:
domain:
version:
status:
owner:
authors:
reviewers:
created:
updated:
tags:
---

Idioma¶

Conteúdo:

Português (Brasil)

Arquivos:

Inglês

Exemplos:

overview.md
roadmap.md
leads.md
contacts.md
pipeline.md

Estrutura¶

Sempre utilizar títulos Markdown.

# Título

## Seção

### Subseção

Nunca numerar capítulos.

Correto:

## Objetivo

Errado:

## 1. Objetivo

Diagramas¶

Sempre utilizar Mermaid quando aplicável.

Tipos permitidos:

Flowchart
Sequence
ER
Mindmap
Gantt
State
Journey

Código¶

Todo código deve possuir linguagem definida.

Exemplo:

print("CoreFlow")

Tabelas¶

Sempre utilizar Markdown.

Nunca utilizar imagens de tabelas.

Links¶

Preferencialmente relativos.

Exemplo:

../crm/leads.md

Imagens¶

Todas as imagens ficam em:

assets/images/

Diagramas exportados:

assets/diagrams/

Nomenclatura¶

Pastas:

snake-case

Arquivos:

kebab-case

Classes:

PascalCase

Variáveis:

snake_case

APIs:

/api/v1/

Versionamento¶

Utilizar Semantic Versioning.

1.0.0
1.1.0
2.0.0

Diagramas Obrigatórios¶

Sempre que possível incluir:

Fluxograma
Sequência
ER
Arquitetura

IA¶

Toda documentação deve ser escrita considerando consumo por:

ChatGPT
Claude Code
OpenCode
Cursor
GitHub Copilot

Commits¶

Utilizar Conventional Commits.

Exemplos:

docs(crm): documenta módulo Leads

docs(api): adiciona autenticação JWT

docs(database): cria documentação Accounts

Objetivo Final¶

A documentação da CoreFlow Platform deverá ser suficiente para que uma equipe de desenvolvimento ou um agente de IA consiga implementar qualquer módulo apenas consultando esta base documental.