Documentation


My Paper To-Do Strategy

Coding up a to-do app may be the Hello, World of every framework, but when it comes to actually tracking tasks effectively (knock ’em out not stack ’em up) there’s no app that keeps things front of mind better than an open notebook on your desk. Here’s my

Documentation
My Paper To-Do Strategy

How to Write Good Documentation

If you’ve ever half-written a software project before taking a few days off, this is the article you’ll discover you needed when you reopen that IDE. In the technology teams I lead, we make a constant effort to document all the things. Documentation lives alongside the code as

Documentation
How to Write Good Documentation

Make Your Team More Productive by Literally Doing One Thing

In the tech teams I lead, “priority” has no plural form. Whether you’re leading a team of people or leading yourself, it’s important to take account of all the important things that need doing in your organization. This does not mean that everything can be equally important. Logically,

Leadership
Make Your Team More Productive by Literally Doing One Thing

How to Create a Self-Documenting Makefile

My new favorite way to completely underuse a Makefile? Creating personalized, per-project repository workflow command aliases that you can check in. Can a Makefile improve your DevOps and keep developers happy? How awesome would it be if a new developer working on your project didn’t start out by copying

Computing
How to Create a Self-Documenting Makefile

Word Bugs in Software Documentation and How to Fix Them

I’ve been an editor longer than I’ve been a developer, so this topic for me is a real root issue. 🥁 When I see a great project with poorly-written docs, it hits close to /home. Okay, okay, I’m done. I help the Open Web Application Security Project (OWASP)

Documentation
Word Bugs in Software Documentation and How to Fix Them

Subscribe

Receive new posts in your inbox.

Success! Check your email to confirm your subscription.