Browse categories
English
$
USD
Connect to your AI
I will write a clear readme and setup guide for your web project
About this Gig
Give developers a clear starting point for your small web project.
I document one agreed project with up to 5 relevant source/configuration files and 500 non-empty lines in total. Each package uses this same code scope; higher tiers add documentation depth.
Basic: README up to 800 words, prerequisites, setup, one usage example and verification notes.
Standard: up to 1,400 words across README and troubleshooting notes, with up to 3 agreed usage examples.
Premium: up to 2,000 words across README, setup/troubleshooting and developer handover notes, with up to 5 agreed examples.
I check claims against the supplied version and verify safe, agreed local steps in one environment. Unverified steps and missing prerequisites are clearly marked. Deliverables are editable Markdown files.
AI supports drafting; I manually validate the documentation. Credentials, personal data, source code and confidential material are not sent to AI tools without prior written consent.
No code fixes, deployment, paid services, security audit or full API-reference site. Send the project scope and stack before ordering. English or Dutch; one scoped revision.
Document type:
Documentation
Industry:
Software
Language:
Dutch
•
English
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.
FAQ
How large can my project be?
All packages cover one project with up to 5 relevant source/configuration files and 500 non-empty lines in total. Vendor, generated and minified files are excluded from review. Higher packages increase documentation depth, not repository size. Send the file list and stack first so I can confirm fit.
What do the word and example limits include?
Basic includes one README up to 800 words and one usage example. Standard includes up to 1,400 words total and 3 examples. Premium includes up to 2,000 words total and 5 examples. These are caps, not filler targets; the documents can be shorter when that explains the project clearly.
Will you run my project or document any programming language?
We agree on a supported stack, version and one local environment first. I verify safe steps within scope; no unsafe code, secrets or paid services. Missing dependencies and unverified steps are clearly recorded. I do not promise every technology or operating system.
Will you fix bugs, deploy the project or write full API documentation?
No. I document the agreed version and provide verification notes. Code repairs, features, deployment, production access, full API-reference sites, security reviews and extra environments are excluded. Existing problems may be documented without claiming they are fixed.
Can you use private code, and do you use AI?
Share only authorized code and remove secrets and personal data. AI may help draft; I manually validate documentation against source and permitted tests. Source code and non-public material are not sent to external AI without prior written consent. Agree on handling confidential material first.
What files, languages and revisions do I receive?
Editable Markdown files, a change summary and verification notes, in English or Dutch. One revision covers corrections or clarification for the original version, files, examples and environment. New versions, features or environments need a separate agreement.
