Hey Matt,
This looks like a good approach, and one I've taken several times when working in an existing project. One pitfall I fell into was correcting/fixing bad docs I came across while adding changes to the parts I was updating.
What about documentation generators like Sphinx? I've had some success in getting these in place, and convincing the team devs to simply update their inline comments (Python) so the generator will pick things up.
Thanks Dave! Haven't heard of Sphinx, but yes that's a great approach. I wrote this from the standpoint of long-form guides, but anything that automates/generates docs for you is definitely a big win. I believe our team does something similar with the UI Component pages of the Ionic docs.
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
Hey Matt,
This looks like a good approach, and one I've taken several times when working in an existing project. One pitfall I fell into was correcting/fixing bad docs I came across while adding changes to the parts I was updating.
What about documentation generators like Sphinx? I've had some success in getting these in place, and convincing the team devs to simply update their inline comments (Python) so the generator will pick things up.
Thanks Dave! Haven't heard of Sphinx, but yes that's a great approach. I wrote this from the standpoint of long-form guides, but anything that automates/generates docs for you is definitely a big win. I believe our team does something similar with the UI Component pages of the Ionic docs.