Writing User Documentation for ACF

From Alpine Linux
Revision as of 20:04, 29 May 2009 by Aalatchm (talk | contribs) (Created page with '= Guidelines on Writing User Documentation for ACF = Many users of Alpine Linux devices may use only the ACF Web interface. == Basic suggestions == *Write names and labels ''as...')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Guidelines on Writing User Documentation for ACF

Many users of Alpine Linux devices may use only the ACF Web interface.

Basic suggestions

  • Write names and labels as they appear in ACF, such as "DNScache" instead of dnscache.
  • Avoid using extra nouns such as "menu option," "tab," "section," etc. for simplicity. The formatting below should be sufficient.

Formatting

Here is an example of the suggested formatting:


System: Local Backups > Config > System Info: Media for Commit

When describing an page or procedure in ACF, user documentation may refer to items such as:

  • menu choices
  • tabs
  • section headings
  • buttons
  • links
  • check boxes
  • fields