4 ms·
Or let the Junior rewrite the docs while they're scratching their head, and push an update once they've figured it out.
by aDyslecticCrow 1y ago
Or let the Junior rewrite the docs while they're scratching their head, and push an update once they've figured it out.
- efitz 1y agoWow, way to double down on “I really hate everyone who doesn’t have exactly my skill set and experience.”
- trashymctrash 1y agoI think you are misreading the parent comment here.
- aDyslecticCrow 1y agoI'm ... confused what you mean. If the junior is gonna untangle the docs anyway, why not make them directly update the parts that confused them once they're through it.
- efitz 1y agoI apologize; I misunderstood. I thought you were making a “fend for yourself” argument; I was not associating “junior devs on the team making the docs, need to fix docs or make good ones”.
- turtleyacht 1y agoThey're not necessarily prohibited from asking questions if they're stuck, though. But also search in the chat channels for similar issues. Updating docs in source control also onboards folks to code review. It would be weird to update docs and get a hostile reception. While nice to walk through with someone and conduct a usability study, just leave it better for the next person (who could be yourself, if you forget). That has happened before.
- Lalabadie 1y agoI'm a senior designer who often contributes to front-end code when it's convenient for my client. Fixing and updating the README when I join a new team and set up their dev environment is always extremely well-received.
- aDyslecticCrow 1y agoIf i'm gonna untangle something, i may as-well write some notes. If i'm writing notes on it already, i may as-well refine the grammar a bit and update the docs. It's really quite small effort compared to the main work of learning the system, so i don't quite get why so few people do it.