ACF 用户文档编写指南

许多 Alpine Linux 设备的用户可能只使用 ACF Web 界面。因此，以清晰、一致的方式记录 ACF 的操作步骤很有益处。这些指南可用于编写简洁的文档，使用 ACF 而不是命令行。

基本建议

按照 ACF 中显示的样子书写名称和标签，例如 "DNScache" 而不是 dnscache。
为了简洁起见，避免使用多余的名词，例如“菜单选项”、“标签”、“部分”等。下面的格式应该足够了。
指定完整的导航路径，以便用户无论从哪里开始都可以按照说明操作。

格式化

这里是一个建议格式的示例

System: Local Backups > Status > Commit Changes: Commit

以下是用用户文档中常见项目的格式。所有导航字符串都应该用斜体表示（或者在纯文本中，使用正斜杠 /导航 > 示例/）。

菜单选择、标签页、按钮、链接
- 用户需要点击的任何文本都应该用粗体（斜体）字体（或者在纯文本中，使用星号 *按钮名称*）。文本后面应该跟一个大于号 ">"。
- 链接前面可以有一个标签和一个冒号“:”。
章节标题
- 标题后面应该跟一个冒号“:”。
复选框
- 复选框选中时应使用 [X]，未选中时应使用 [_]。
字段
- 字段名称没有特殊格式。
下拉框
- 在框的标签和要选择的选项之间使用大于号 ">"。

示例

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