Writing User Documentation for ACF - Revision history

Dubiousjim: delete Category:HOWTO

2012-03-21T16:06:04Z

delete Category:HOWTO

← Older revision		Revision as of 16:06, 21 March 2012
Line 36:		Line 36:
	''System: '''Logfiles''' > '''Status''' > /var/log/messages: '''Tail'''		''System: '''Logfiles''' > '''Status''' > /var/log/messages: '''Tail'''

	[[Category:ACF~~]] [[Category:HOWTO~~]]		[[Category:ACF]]

Dubiousjim: Categories

2012-03-12T07:08:46Z

Aalatchm: better introduction

2009-06-01T13:16:57Z

better introduction

← Older revision		Revision as of 13:16, 1 June 2009
Line 1:		Line 1:
	= Guidelines on User Documentation for ACF =		= Guidelines on User Documentation for ACF =

	Many users of Alpine Linux devices may use only the ACF Web interface.		Many users of Alpine Linux devices may use only the ACF Web interface. Therefore, it is beneficial to have a clear, consistent way of documenting procedures with ACF. These guidelines can be used to write concise documents that use ACF instead of the command line.

	== Basic suggestions ==		== Basic suggestions ==

Aalatchm at 20:54, 29 May 2009

2009-05-29T20:54:00Z

← Older revision		Revision as of 20:54, 29 May 2009
Line 1:		Line 1:
	= Guidelines on ~~Writing~~ User Documentation for ACF =		= Guidelines on User Documentation for ACF =

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

Aalatchm: added details

2009-05-29T20:53:36Z

added details

← Older revision		Revision as of 20:53, 29 May 2009
Line 6:		Line 6:
	*Write names and labels ''as they appear in ACF'', such as "DNScache" instead of dnscache.		*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.		*Avoid using extra nouns such as "menu option," "tab," "section," etc. for simplicity. The formatting below should be sufficient.
			* Specify the entire navigation, so that the user can follow the instructions no matter where he starts.

	== Formatting ==		== Formatting ==
Line 11:		Line 12:
	Here is an example of the suggested formatting:		Here is an example of the suggested formatting:

			''System: '''Local Backups''' > '''Status''' > Commit Changes: '''Commit'''

	''~~System: '''Local Backups'~~'' > ~~'''Config'''~~ > ~~System Info: Media for Commit''~~		Below is the formatting for common items in user documentation. All navigation strings should be in ''italics'' (or in plaintext, use forward slashes <code>/NAVIGATION > EXAMPLE/</code>).

	~~When describing an page~~ or ~~procedure~~ in ~~ACF~~, ~~user documentation~~ may ~~refer to items such as~~:		*Menu Choices, Tabs, Buttons, Links
	*~~menu choices~~		*Any text the user needs to click on should be in '''''bold (italic) typeface''''' (or in plaintext, use asterisks <code>BUTTONNAME*</code>). The text should then be followed by a greater-than symbol ">".
	*~~tabs~~		**Links may be preceded by a label and a colon ":".
	*~~section headings~~		*Section Headings
	*~~buttons~~		**Headings should be followed by a colon ":".
	*~~links~~		*Check Boxes
	*~~check boxes~~		**Check boxes should be followed by ''[X]'' for selected, and ''[_]'' for unselected.
	*~~fields~~		*Fields
			**Field names have no special formatting.
			*Drop-down Boxes
			**Use a greater-than symbol ">" between the label of the box and the option to choose.

			=== Examples ===
			''System: '''Local Backups'''
			''System: '''Local Backups''' > '''Status''' > Commit Changes: Simulate a commit [X]
			''System: '''Local Backups''' > '''Status''' > Commit Changes: Simulate a commit [_]
			''System: '''Local Backups''' > '''Config''' > System Info: Media for Commit > usb''
			''System: '''Local Backups''' > '''Config''' > Edit Included Files: Included item(s)
			''System: '''Logfiles''' > '''Status''' > /var/log/messages: '''Tail'''

Aalatchm: 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...'

2009-05-29T20:04:28Z

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...'

New page

= 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

← Older revision		Revision as of 07:08, 12 March 2012
Line 35:		Line 35:
	''System: '''Local Backups''' > '''Config''' > Edit Included Files: Included item(s)		''System: '''Local Backups''' > '''Config''' > Edit Included Files: Included item(s)
	''System: '''Logfiles''' > '''Status''' > /var/log/messages: '''Tail'''		''System: '''Logfiles''' > '''Status''' > /var/log/messages: '''Tail'''

			[[Category:ACF]] [[Category:HOWTO]]