Hi Guys, To give you guys context, recently I was talking with my colleague on how we don't have a proper documentation on how we have done our code/solution/infra (basically everything). I wanted fix this so planned on creating a way we could document all things related to developing a feature/solution.
So I decided on doing two things
- Create a documentation to serve as knowledge Hub
- which could be used by any member in the company, and would be subjected to constant review and updates as our collective knowledge grows.
- Create a documentation template for individual projects
- which could be forked by any project to mcreate their on documentation.
So I planned on acheiving this using docusauraus for static site generator, and github and github pages for reviewing and deploying purposes.
But before I proceed further, I thought it's best to ask what other companies do so I could make a better decision. so here I am.
So I would like to know what you guys do interms of documenting. for instance.
What tools do you use for documentation (if it's free, then great)
Is there a template on how you create a documentation. like technical documentation would contain certain topics it should cover like what it does, To DO, limitations etc.
How do you document technical document and non-technical document.
Do your company have a repository of shared knowledge. if so what it does and how it is done and maintained
Any advice is welcome and thanks for your replies
Top comments (0)