Ik schrijf een duidelijke readme en snelle start voor je python project

Sommige informatie is automatisch vertaald.

Japan

Ik spreek Japans, Engels

Ondersteuning bij onderzoek en documentatie

Ik help onderzoek en technische informatie om te zetten in duidelijke, bruikbare documentatie. Ik bied bron-ondersteunde onderzoeksbrieven, verbeteringen aan README en quick-start gidsen voor kleine P...
Over deze dienst

Help nieuwe gebruikers je Python project begrijpen en hun eerste succesvolle run voltooien.


Ik maak of verbeter één Engelse README voor een klein, openbaar Python project: doel, vereisten, setup, één gebruiksvoorbeeld, verwachte output, configuratienotities en troubleshooting.


Basis omvat tot 800 woorden, één Markdown-bestand, een wijzigingssamenvatting en verificatienotities. Scope: tot 5 bronbestanden en 500 regels code, met één veilige lokale uitvoering op een afgesproken omgeving. Onverificate stappen zijn duidelijk gemarkeerd.


Mijn portfolio voorbeeld is zelf-initiatie en AI-ondersteund, geen klantwerk. AI-ondersteunde opmaak wordt gecontroleerd aan de hand van de aangeleverde bron en toegestane lokale tests.


Stuur eerst een bericht met de openbare repository, doelgroep en exacte versie. Geen geheime of privé klantgegevens. Geen codefixes, live deployment, API-reference site, betaalde dependencies, security audit of extra operating-system tests. Eén revisie dekt de afgesproken scope; nieuwe functies vereisen een aparte offerte.

Type document:

Documentatie

Taal:

Engels

Voorkeur voor een leveringsstijl

Laat het de freelancer weten als je voorkeuren voor of zorgen hebt over het gebruik van AI-tools voor het voltooien en/of leveren van je bestelling.