|
|
|
|
|
by more_corn
1931 days ago
|
|
The style of the content is often more important than the structure. I've invented a documentation style I call "Notes for Nerds"
It consists of the specific notes you make for yourself if you need to re-implement something complicated you've done. It's example driven, very specific and includes only such verbiage as necessary to contextualize the specific technical commands or code. I invented it because I found at Google that the best documentation was always the rough first pass stuff before it got prettied up. I specifically searched for deprecated documentation because it covered the technical exploration of the project before the final gloss was applied. Compare this to Google's public documentation if you want to throw up in your mouth a little bit. Notes for Nerds style works smashingly. I hereby grant the reader the right to re-implement my idea anywhere you like. Also, don't use Confluence. It is everything bad and wrong about a documentation tool. If Notion had a ticket system they would kill Atlassian overnight. |
|