Photo by Aliaksei Semirski on Pexels. We’ve all been there. The team is firing on all cylinders, cranking out innovative new features. The documentation is perfect! It’s comprehensive, clear, and included right in the Pull Request. Then, six months later, a bug report comes in. Somewhere along the way, a developer changed a timeout value, renamed a key in a JSON response, or updated a UI label, and…the documentation didn’t move an inch. ...
Photo credit: by Sara Kurfeß at Unsplash. I started using Git and GitHub for docs in 2019. It’s been a slow build, but I’ve finally started to learn some helpful ways of going about things. So there are two GitHub specific tips I want to share with you that have helped me out in my day to day. Choose where a repo’s notifications go For the longest time, I just let all of my notifications go to whichever default email address I had defined. This meant that all of my GitHub notifications wound up going to my work email, because work had the majority of the notifications. ...