Comprehensive system for documentation and handoff of developer project
Posted
by
Uzumaki Naruto
on Programmers
See other posts from Programmers
or by Uzumaki Naruto
Published on 2014-06-12T13:51:31Z
Indexed on
2014/06/12
15:39 UTC
Read the original article
Hit count: 280
documentation
|documentation-generation
I work on a technology team that typically develops projects for a period of time, and then hands off to other groups for long-term maintenance and improvements. My team currently uses ad hoc methods of handing off documentations, such as diagrams, API references, etc. Is there a open source solution (or even proprietary one) that enables us to manage:
- Infrastructure/architecture/software diagrams
- API documentation
- Directory structures/file structures
- Overall documentation summaries
in one place? E.g., instead of using multiple systems like Swagger, Wikis, etc. - is there a solution that can seamlessly combine all of these? And enable us to generate a package including all 4 key items with one click to hand off to other teams.
© Programmers or respective owner