The Modern Web

Useful technology, techniques and stories from modern web development and design

Showcase: Solve your Git errors with ohshitgit.com

Filed under: Git, Showcase, Web Development

Title card for the showcase entry about solving Git errors with ohshitgit.com

A showcase of a memorable Git troubleshooting resource for developers who need fast fixes for common version-control mistakes.

The problem with Git documentation

Git's own documentation is thorough and, at the moment you need it, almost entirely unhelpful. It is organised around commands rather than around the situations people find themselves in, so a developer who has just committed to the wrong branch has to already know which command they are looking for.

A resource organised around panic

ohshitgit.com inverts that. Each entry starts with the situation in plain language, then gives the sequence of commands that gets you out of it, with a short note on what the commands actually do. It is a single page with no navigation to learn, which is the right shape for something you open in a hurry.

The common entries cover the ones everyone hits: undoing the last commit while keeping the changes, changing a commit message, committing to the wrong branch, and the general case of wanting to go back to a known good state.

Why the format works

The site is worth studying as an information design exercise as much as a Git reference. It is fast, it is text, it has no onboarding, and its headings are written the way a user would describe their own problem rather than the way the tool describes its features.

That is a pattern worth stealing for internal documentation. Most team wikis would be more useful if their headings were symptoms rather than subsystems.

The Modern Web · Copyright 2017 · Published with WordPress · Sitemap