Escreverei um README claro e um guia de configuração para seu projeto

Algumas informações foram traduzidas automaticamente.

Japão

Eu falo Japonês

Revisor de código e especialista em QA de aplicativos web

Eu reviso código em Python, FastAPI, TypeScript e IA-assisted, testo fluxos de web-apps e escrevo guias claros de README/configuração. Você recebe descobertas priorizadas, passos reproduzíveis, captur...
Sobre este Serviço

Um novo colaborador consegue começar seu projeto sem precisar perguntar o que fazer a seguir?


Vou transformar seu repositório e os passos de configuração verificados em um README ou guia de configuração claros que outra pessoa possa seguir.


Sua documentação pode incluir:

propósito e escopo do projeto

pré-requisitos e ambiente suportado

passos de instalação

nomes de variáveis de ambiente sem valores secretos

comandos de execução, build e teste

resultados de verificação esperados

notas de resolução de problemas

limitações conhecidas e incógnitas claramente marcadas


Vou verificar as instruções fornecidas com o projeto correspondente sempre que possível e separar passos verificados de suposições.


Por favor, envie o repositório ou arquivos relevantes, seu README atual se disponível, os passos reais de configuração/execução/teste, versões suportadas de OS e runtime, e o resultado esperado. Remova senhas, chaves de API, dados pessoais e todos os outros segredos antes de enviar.


Este serviço cobre documentação e verificação limitada. Não inclui implantação em produção, refatoração completa do código, auditoria de segurança formal ou garantia de que todos os ambientes irão se comportar de forma idêntica.

Tipo de Documento:

Manuais de usuário e treinamento

Idioma:

Inglês

•

Japonês

Preferência de estilo de entrega

Informe o freelancer sobre suas preferências ou preocupações em relação ao uso de ferramentas de IA na conclusão e/ou entrega de seu pedido.

Meu portfólio