Sample work · Texts & Docs
Technical Documentation: Installation and API from Code
Installation guide and API reference, generated from code and interface description. Every example in the documentation was executed, and a gap in the code was reported instead of being glossed over.
Sample work (demo), not a client job. Built as a trial task with invented example data; the check figures below come from the automatic test run and are not polished.
What was built
- Every public function and every route described
- Code examples that run as tests
- Missing descriptions in the code are mentioned, not invented
How it was checked
Automatic test run on 2026-10-31, taken from the log (test data invented, figures measured):
- Generated from code/docstrings/OpenAPI: INSTALLATION.md + API.md
- 5/5 public functions and 5/5 routes documented, gap correctly reported (lagerverwaltung.kern.protokoll_als_text)
- 4 pycon examples via doctest (0 errors), 5/5 Python HTTP examples running
Limits
What this sample does not cover, so nobody expects more:
- Descriptions originate from the code's docstrings/OpenAPI - what is missing there is marked as a gap, not invented; technical explanations (architecture, operations, why) must be added by someone else
- Python projects (AST, Google docstrings) and FastAPI/OpenAPI; other languages only via an OpenAPI file
- Installation guide executed locally on Windows (server start + quick test); Linux/macOS commands not verified on a real system; pip install itself not re-run (packages ...
- Output Markdown; Sphinx/MkDocs website would be an additional step
Something like this for your business?
Describe briefly what you need. You get a fixed price before I start; nothing happens without your yes.