Hacker News new | ask | show | jobs
by domtron_vox 2692 days ago
Ironically I'm rolling out a new documentation initiative at my workplace this friday after about a year of work.

I'm using mediawiki with quite a few extentions to meet our needs.

I designed the structure around use cases since the documentation is for me and my coworkers to make us more effective. I'm also making it clear that if they have any issues or frustrations to contact me and I'll try to fix them quickly. I.e. lower the bar as much as possible to get people to use it.

As a general rule if someone is asked a question (internally) more then twice it should be documented to help save them time.

For our structure we use a heavily formatted main page with the 1st half focused on handeling emergancies, req/report forms, and general quick links. The 2nd half categorises all pages into 3 functional groupings. Guides to handle step by step process pages, notebooks for longer explanations for training etc, and referance for lists/tables of data.

These are then further divided into department focused groups.

Tl;dr IMHO do a bottom up design based on use cases like emergancies, quick lookup, normal day to day tasks, edge cases, etc.