Getting Started

Bem-vindo ao People Tech Docs! Esta seção vai ajudá-lo a começar rapidamente.

Para Novos Membros do Time

Se você acabou de entrar no time, comece por aqui:

1. 📚 Guia de Onboarding - Setup do ambiente e primeiros passos
2. 🤝 Team Agreements - Acordos e cultura do time
3. 🔄 Git Workflow - Como trabalhamos com Git
4. 📋 RFC Process - Como tomamos decisões técnicas

Para Desenvolvedores Experientes

Consultando documentação específica:

• Architecture Overview - Entender a arquitetura
• API Reference - Documentação das APIs
• Testing Guides - Como testar backend e frontend
• CI/CD - Pipelines e deployment
• Runbooks - Procedimentos operacionais

Documentação Viva

Nossa documentação é gerada automaticamente do código:

APIs (FastAPI + Swagger)

As APIs são documentadas automaticamente. Acesse:

• Swagger UI Interativo - Testar endpoints
• OpenAPI Spec: docs/api-reference/openapi-spec.yaml

Código Python (mkdocstrings)

Documentação extraída de docstrings:

• Services
• Models
• Utils

Database (PostgreSQL + Alembic)

• Migrations - Processo de migrations
• Schema - ER Diagram atualizado

Estrutura da Documentação

📁 People Tech Docs
├── 🏠 Home - Você está aqui
├── 🚀 Getting Started - Onboarding e primeiros passos
├── 📋 RFC Process - Propostas e decisões técnicas
├── 💻 Development - Git workflow e padrões
├── 🏗️ Architecture - Arquitetura e design
├── 🔧 Infrastructure - AWS SAM, database, ambientes
├── 🧪 Testing - Estratégias e guias de testes
├── 🚀 CI/CD - Pipelines automatizados
├── 📊 Observability - CloudWatch e monitoring
├── 🔒 Security - Secrets e secure coding
├── 📖 Runbooks - Procedimentos operacionais
├── 🌐 API Reference - Swagger UI e OpenAPI
└── 💾 Code Reference - Docs geradas do código

Como Contribuir

Atualizar Documentação

1. Clone o repositório:

   git clone https://github.com/seu-org/people-tech-docs.git
   cd people-tech-docs
   

2. Instale as dependências:

   pip install -r requirements.txt
   

3. Execute localmente:

   mkdocs serve
   

4. Faça suas alterações em docs/

5. Teste e commit:

   git checkout -b docs/minha-contribuicao
   git add docs/
   git commit -m "docs: adicionar guia X"
   git push origin docs/minha-contribuicao
   

6. Abra um Pull Request

Propor Mudanças Técnicas

Para mudanças arquiteturais ou processos, use RFCs:

1. Copie o template
2. Preencha com contexto, proposta e alternativas
3. Abra PR com label rfc
4. Apresente na reunião quinzenal

Atalhos Úteis

Atalho	Ação
Ctrl + K ou /	Buscar na documentação
Ctrl + Click	Abrir link em nova aba
Setas ← →	Navegar entre páginas

Suporte

• 💬 Slack: #tech-docs
• 🐛 Issues: GitHub Issues
• 📧 Email: tech-docs@seutime.com

Próximos Passos

Escolha seu caminho:

• Sou novo no time

  ---

  Comece pelo guia de onboarding completo

  Onboarding

• Quero entender a arquitetura

  ---

  Veja como nossos sistemas funcionam

  Architecture

• Preciso fazer deploy

  ---

  Consulte os runbooks operacionais

  Runbooks

• Tenho uma proposta técnica

  ---

  Crie uma RFC para discussão

  RFC Process