3 ms·
Documentation is for everyone. Put it where everyone can read it, not hidden in the most esoteric place possible, via a very unfriendly tool. I do that often
by mixmastamyk 3y ago
Documentation is for everyone. Put it where everyone can read it, not hidden in the most esoteric place possible, via a very unfriendly tool.
I do that often and call it the developer guide. After the user and ops guides.
Not to mention comment and doc strings about why in the current code.
- _Algernon_ 3y agoThis entire thread is making me feel like I'm taking a crazy pill. A simple git log is considered "esoteric" these days? No extra command line arguments are required to read the entire commit message. If so software "engineering" is truly a dead discipline. I guess the "move fast and break things" crowd have taken over.
- ChrisMarshallNY 3y agoNot sure why you're attacking me. I don't remember saying anything offensive. Anyway, I've never been a fan of "moving fast and breaking." Might want to give that blog entry I linked, a read.
- mixmastamyk 3y agoNever worked with other people? Git as a thing is off the table. Which commit? One month ago or three? Pro{gram,ject,duct}M, SME, QA, or user wants to know why? Do they even have a login to the systems they’d need? Is there search so they could find it themselves when you quit? Or you could send them a link to the docs.