stf on Nostr: writing man pages is so useful to check if your interface actually makes sense from a ...
writing man pages is so useful to check if your interface actually makes sense from a user perspective.
writing specifications for protocols is similarly essential for understanding and revising overlooked details, misplaced assumptions and plain embarrassing decisions made during development.
i'm currently writing man/specs for klutshnik but had the same epiphany also during other projects.
if you don't write docs, you rob yourself of a very powerful and simple review technique.
Published at
2025-05-07 01:30:55Event JSON
{
"id": "b9b21f317e0c9782ff8c28340e02a3721a5f7b7fce58835410f36ec762907fcd",
"pubkey": "b887bffcf63863763c712604944ba34cf6b4674aba9d9ad586fda383be9f07c8",
"created_at": 1746581455,
"kind": 1,
"tags": [
[
"proxy",
"https://chaos.social/users/stf/statuses/114463962257105170",
"activitypub"
],
[
"client",
"Mostr",
"31990:6be38f8c63df7dbf84db7ec4a6e6fbbd8d19dca3b980efad18585c46f04b26f9:mostr",
"wss://relay.mostr.pub"
]
],
"content": "writing man pages is so useful to check if your interface actually makes sense from a user perspective. \n\nwriting specifications for protocols is similarly essential for understanding and revising overlooked details, misplaced assumptions and plain embarrassing decisions made during development.\n\ni'm currently writing man/specs for klutshnik but had the same epiphany also during other projects.\n\nif you don't write docs, you rob yourself of a very powerful and simple review technique.",
"sig": "6ab7d34e1c9b320de6dc6e4f6cfd32560c928617212cdf7511fef0aca5fe008468995d9eed26821961d228e4f146eeefd14215448df5df3bae73fcc1cb10a76f"
}