{"id":171,"date":"2020-02-24T09:40:24","date_gmt":"2020-02-24T14:40:24","guid":{"rendered":"http:\/\/redmonk.com\/kfitzpatrick\/?p=171"},"modified":"2020-02-24T10:39:14","modified_gmt":"2020-02-24T15:39:14","slug":"docs-roundup-1-3","status":"publish","type":"post","link":"https:\/\/redmonk.com\/kfitzpatrick\/2020\/02\/24\/docs-roundup-1-3\/","title":{"rendered":"Docs Roundup 1.3"},"content":{"rendered":"

Recent docs (and tech comm) items of interest: commit messages; new docs for Launch Darkly; questions of form and audience; some comics about Git<\/span><\/i><\/p>\n

\"Illustration<\/p>\n

Commit Messages<\/span><\/h1>\n

\"Comic<\/p>\n

As this <\/span>oft-cited xkcd comic<\/span><\/a> illustrates, good commit messages can be difficult to compose, especially once the author is hours into a work session. And yet, a good commit message can save hours of detective work later on. <\/span><\/p>\n

It is therefore important to have a set of commit message best practices established <\/span>before<\/span><\/i> starting work on a project or product. Whether you are working solo on your own project or looking to improve or standardize commit message practices for your team, these commit messages resources are worth a look:<\/span><\/p>\n

    \n
  • Using Git Commit Message Templates to Write Better Commit Messages<\/span><\/a>: a template from <\/span>Lisa Wold Eriksen<\/span><\/a> that incorporates a number of best practices.\u00a0<\/span><\/li>\n
  • How to Write a Git Commit Message<\/span><\/a>: a post from <\/span>Chris Beams<\/span><\/a> that breaks down why good commit messages matter and how to produce them.<\/span><\/li>\n
  • The Art of the Commit<\/span><\/a> by <\/span>David Demaree<\/span><\/a>: discusses commit message process, elements of style, and has a nice take on framing the log message as a headline.\u00a0<\/span><\/li>\n
  • How to Write Useful Commit Messages (My Commit Message Template)<\/span><\/a>: a recent post AND template from <\/span>Jacob Herrington<\/span><\/a> that is part of a larger <\/span>Git Guide series<\/span><\/a>.<\/span><\/li>\n<\/ul>\n

    Launch Darkly Docs\u00a0<\/span><\/h1>\n

    Launch Darkly<\/span><\/a> (a <\/span>key player<\/span><\/a> in the realm of <\/span>Progressive Delivery<\/span><\/a>, one of the <\/span>2020 focus areas<\/span><\/a> for my colleague James) recently announced a rebuild of their documentation site:<\/span><\/p>\n

    \n

    An incredible team @LaunchDarkly<\/a> rebuilt our docs site and I'm so excited and proud of what we've accomplished. <\/p>\n

    The new Github-based workflow lays the foundation for a more vibrant community around our docs. Check it out! Leave us a PR! HOORAY!https:\/\/t.co\/s2RWkyiK6k<\/a><\/p>\n

    — Sarah Day (@scribblingfox) February 14, 2020<\/a><\/p><\/blockquote>\n