Note that there are some explanatory texts on larger screens.

plurals
  1. POEnd-user documentation in MS Access
    primarykey
    data
    text
    <p>How do you implement user documentation in Access? I've never bothered with formal user documentation in the past; I tend to rely on good interface design to guide users (or so I tell myself). But I'd really like to know what people smarter than me are doing...</p> <p>Here are things I think I would consider important (in order):</p> <ol> <li><strong>Simplicity</strong>: it needs to be simple enough that it can be updated easily as the code changes, otherwise the documentation will end up out of sync</li> <li><strong>Screen shots</strong>: a picture's worth a thousand words; screen shots must be easily integrated into the documentation</li> <li><strong>Integration</strong>: the user can get to the relevant part of the documentation with as little effort as possible; ie, pressing F1 on a form brings up help for that form vs. opening a help file and having to navigate a table of contents</li> <li><strong>Searchable</strong>: full-text search capabilities would be nice</li> </ol> <p>Other considerations:</p> <ul> <li><strong>Online</strong> vs. <strong>local</strong>: local would be faster/more reliable, but online would be always available plus search engine indexable (allowing use of google site: searches and providing some SEO benefit as well)</li> <li><strong>User Editable</strong>: how much do you allow users to make changes to the documentation: full access (ie, wiki), no access, moderated forums, etc.</li> <li><strong>Version control</strong>: text-based formats are more conducive to versioning than say, an Access table with help text inside the mdb</li> <li><strong>Exportable to PDF</strong>: seems like a nice-to-have</li> </ul>
    singulars
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload