Como melhorar documentação em ciência da computação em Ciência da Computação
Prompt gerado automaticamente para Documentação em Ciência da Computação em Ciência da Computação
Você é um especialista em documentação de software com vasta experiência em Ciência da Computação. Seu objetivo é ajudar desenvolvedores a criar documentação técnica clara, concisa e útil para projetos de software.
**Tarefa:** Crie um prompt detalhado e criativo para uma ferramenta de IA que gere automaticamente seções de "Guia de Instalação e Configuração Inicial" para projetos de código aberto. A ferramenta deve ser capaz de adaptar o conteúdo com base no tipo de projeto (e.g., aplicação web, biblioteca Python, serviço de linha de comando) e no nível de conhecimento esperado do usuário (e.g., iniciante, intermediário, avançado).
**O prompt deve incluir:**
1. **Objetivo Principal:** O que a IA deve gerar.
2. **Parâmetros de Entrada (Exemplos):** Que informações o usuário fornecerá à IA para guiar a geração. Pense em variáveis que definem o contexto do projeto.
3. **Critérios de Qualidade/Características Desejadas da Saída:** O que torna a documentação gerada "boa"? (Ex: clareza, concisão, precisão, formatura, exemplos práticos).
4. **Cenários de Uso (Exemplos):** Como um desenvolvedor usaria essa ferramenta na prática.
5. **Restrições/Limitações (Opcional, mas útil):** O que a IA *não* deve fazer ou o que pode ser um desafio.
6. **Formato de Saída Desejado:** Markdown é preferencial para documentação técnica.
**Exemplo de um pequeno trecho de saída esperada:**
```markdown
## Guia de Instalação e Configuração Inicial
Este guia detalha os passos para instalar e configurar o projeto `[Nome do Projeto]` em sua máquina local.
### Pré-requisitos
Certifique-se de ter os seguintes softwares instalados:
* Python 3.9+
* pip
### 1. Clonar o Repositório
```bash
git clone https://github.com/seu-usuario/[nome-do-projeto].git
cd [nome-do-projeto]
```
### 2. Criar e Ativar o Ambiente Virtual
```bash
python -m venv .venv
source .venv/bin/
Como Usar este Prompt
Clique no botão "Copiar Prompt" para copiar o conteúdo completo.
Abra sua ferramenta de IA de preferência (ChatGPT e etc.).
Cole o prompt e substitua as variáveis (se houver) com suas informações.
Outros prompts de Ciência da Computação
Continue explorando prompts nesta categoria.
Melhores práticas de otimização e performance em ciência da computação para Ciência da Computação
Prompt gerado automaticamente para Otimização e performance em Ciência da Computação em Ciência da Computação
Melhores práticas de debugging em ciência da computação para Ciência da Computação
Prompt gerado automaticamente para Debugging em Ciência da Computação em Ciência da Computação
Melhores práticas de casos de uso práticos em ciência da computação para Ciência da Computação
Prompt gerado automaticamente para Casos de uso práticos em Ciência da Computação em Ciência da Computação