Short term remote project.
Looking for an experienced Technical Writer to document a large python/django codebase in the healthcare/genetics domain.
Documentation
should include:
*all features in natural language with screenshots and appropriate level of detail
*overall system architecture, including integration points with external systems
*API endpoints (which are partly represented by swagger/openAPI docs)
*consumers of exposed API endpoint
*data models and their relationships
*tasks/jobs
*django signals and their effects
*a FAQ based on questions from slack
To be a good fit for this project you should:
*have proven experience in writing technical documentation for sizable projects
*have a good understanding of python/django
*be able to quickly navigate and understand a new codebase
*be willing to sign an NDA
A team of developers and product managers across different time zones will be available
to assist with understanding the code and user flows, but you should be driven
to seek out answers without getting blocked.
Documentation should be produced in MarkDown or similar format, in a searchable tool like
docusaurus.