4 ms·
> What black magic do you have to cast to get devs to look at the documentation? README.md files in each repo, and code level documentation. The readme file ca
by gumballindie 3y ago
> What black magic do you have to cast to get devs to look at the documentation?
README.md files in each repo, and code level documentation. The readme file can point to useful links, such as diagrams or stuffy documents where needed.
- ozim 3y agoYou don't put everything in README.md for the start - once file gets long enough no one will read it the same as bunch of confluence... Links? Parent poster just mentioned he was putting relevant links in JIRA tickets - to work on a feature dev has to open the ticket anyway but suprise-suprise they were not clicking the links. How on earth README.md links will help in such situation.
- gumballindie 3y agoOh when i read documentation i think stuff relevant to getting things to run, architecture and perhaps a little more of whats relevant. Jira tickets and all can be correlated with a proper branching model. I agree, readme files should be concise.