I will write developer documentation, api docs and a clear readme
Senior software engineer, technical writing, developer docs, CI CD and Docker
Level 1
Has met certain performance criteria and shows strong potential in the marketplace.
About this Gig
Your library is good. Your README is three lines and a TODO. That's why nobody adopts it.
I'm a software engineer with 10+ years in .NET, Python and DevOps, and I write the documentation I wish other people's projects had.
WHAT YOU GET
- A README that gets someone from clone to running in five minutes
- API reference written from your actual code, not guessed from names
- Working examples - I run every one before it ships
- Clear install, configuration and troubleshooting sections
- Markdown, MkDocs, Docusaurus or plain files
- English or German (native)
GOOD FIT FOR
Open-source maintainers, SDK and API teams, internal platform teams, and founders who need docs before a launch or a funding round.
SEND ME
Repo access (read is enough), who the reader is - end user, integrator or teammate - and anything that currently confuses people. Your top three support questions are worth more than a spec.
I don't store credentials. NDA welcome.
Docs that keep growing? Ask about a subscription - a fixed amount of documentation work every month, no re-briefing.
Document type:
User & training manuals
•
Documentation
Industry:
General
Language:
English
•
German
Delivery style preference
Please inform the freelancer of any preferences or concerns regarding the use of AI tools in the completion and/or delivery of your order.
