All examplesSample publication · fictional storiesUse this design
Signal
All stories

Practice

Leave a map for the next person

A short README can be the most useful thing you ship this afternoon.

Before closing the project, I wrote down how to start it, where the data lives, and which command checks the build. It took less time than remembering those things had taken me that morning.

Documentation does not have to explain the entire system. Sometimes it only needs to get the next person to a working page, with enough context to make their first change.

The next person may be you in three weeks. Leave them a friendly introduction.

More from Signal

A note from Sam Okafor

A place to return to.

A working journal of useful software, small experiments, and the decisions behind them. This is a fictional publication, made to show what you can build with Caveat.

Make something like this