Estratégias de documentação em react native em React Native

Prompt gerado automaticamente para Documentação em React Native em React Native

5.0
33 usos
ChatGPT
Usar no ChatGPT
"Você é um engenheiro de software sênior com vasta experiência em desenvolvimento mobile. Crie um guia passo a passo, detalhado e pragmático, para a elaboração e manutenção de uma documentação técnica **eficiente e facilmente navegável** para um projeto React Native de médio a grande porte. O guia deve abordar:

1. **Escolha de ferramentas:** Quais as melhores ferramentas (geradores de documentação, ferramentas de diagramação, etc.) e por que? (Ex: Storybook para componentes, TypeDoc para tipagem, etc.)
2. **Estrutura de pastas e arquivos:** Como organizar a documentação dentro do projeto para facilitar o acesso e a manutenção? (Ex: `/docs` no root, `/src/components/ComponentName/docs.mdx`, etc.)
3. **Conteúdo essencial:** O que **não pode faltar** em uma documentação de React Native? (Ex: setup do ambiente, fluxo de autenticação, padrões de arquitetura, componentes reutilizáveis, internacionalização, testes, deployment, etc.)
4. **Padrões de escrita:** Como garantir clareza, concisão e consistência na linguagem e formatação? (Ex: uso de Markdown, exemplos de código, screenshots, diagramas, etc.)
5. **Automação e CI/CD:** Como integrar a geração e publicação da documentação no pipeline de desenvolvimento? (Ex: GitHub Actions para deploy automático, linting de documentação, etc.)
6. **Estratégias de manutenção:** Como garantir que a documentação permaneça atualizada e relevante à medida que o projeto evolui? (Ex: "documentação como código", revisões periódicas, linkagem com issues/PRs, etc.)

O guia deve ser prático, com exemplos de código/estrutura de arquivos e dicas para evitar armadilhas comuns, visando um público de desenvolvedores React Native."

Como Usar este Prompt

1

Clique no botão "Copiar Prompt" para copiar o conteúdo completo.

2

Abra sua ferramenta de IA de preferência (ChatGPT e etc.).

3

Cole o prompt e substitua as variáveis (se houver) com suas informações.

Compartilhe

Gostou deste prompt? Ajude outras pessoas a encontrá-lo!

Outros prompts de React Native

Continue explorando prompts nesta categoria.

Melhores práticas de melhores práticas em react native para React Native

Prompt gerado automaticamente para Melhores práticas em React Native em React Native

Melhores práticas de fundamentos de react native para React Native

Prompt gerado automaticamente para Fundamentos de React Native em React Native

Melhores práticas de melhores práticas em react native para React Native

Prompt gerado automaticamente para Melhores práticas em React Native em React Native