如何编写 HOWTO

来自 Alpine Linux

如果您正在阅读本文,可能意味着您有兴趣向 Alpine Linux Wiki 贡献 Howto 或教程。 这太棒了! 只需按照这些简单的步骤操作,您很快就会得到一篇很棒的 howto。

编写 HOWTO

了解您的读者以及您想告诉他们做什么,并注意命名您的页面。 在 Wiki 中更改页面名称并非易事。

  1. 登录 Alpine Linux Wiki。
    提示: 如果您从未登录过,请点击右上角的“登录/创建账户”,然后点击“创建账户”链接。
  2. 阅读 wiki 编辑的基础知识,并特别参考 Alpine Wiki 的 Help:EditingHelp:Cheatsheet
  3. 如果您是 Wiki 编辑新手,请使用您用户命名空间的子页面,例如 Username/Learning_to_Use_Wiki,或使用 Sandbox 首先创建临时页面。
  4. 基本 HOWTO 模板粘贴到您的新临时页面中。
  5. 按照模板中的说明进行操作。
  6. 在创建标题/子标题时请注意,因为它们可以链接到页面内以及其他 wiki 页面。
  7. 尽可能参考现有的 wiki 内容来完成标准任务,例如安装分区格式化用户管理管理仓库等,而不是在您的页面中重复相同的内容。 这避免了混淆用户并防止内容碎片化。
  8. 始终更新现有的 wiki 页面,以便具有现有 wiki 链接的信息也能受益。 必须谨慎地创建新页面,即仅在绝对必要时才创建。
  9. 最后,移动您的临时页面或按照 Help:Editing 中的说明创建正确命名的 HOWTO 页面,并将您的内容从临时页面粘贴过来。 移动页面会捕获原始页面的更改日志。

学习格式化 Wiki 文本

  • 参考 Help:Editing 以了解文本格式规则。
  • 通过点击 Alpine Linux Wiki 文章上的“编辑页面”按钮来阅读源代码。 请勿意外修改它们。
  • 通过在 Sandbox 中进行实验。
  • 在编辑 wiki 页面时,您可以查找 Cheatsheet 以供快速参考。

基本 HOWTO 模板

基本 HOWTO 的 WikiText 骨架

Summarize your article here so readers can decide
quickly whether to read it. This line appears right 
below the page Title.

== Before You Start Title ==
Your readers might need to get ready before they can do the work.
If so explain those prerequisites first. This section might alternatively 
contain background information readers need to know before they can make 
sense of your example or carry out your instructions.

== Doing Something Title ==
Write the steps of how to do something in this section.
If possible, show an example first, then tell your readers the steps.
Break this procedure into separate procedures to avoid more than
about 7-9 steps per procedure.

 INSERT GREAT EXAMPLE HERE

#Answer the following three questions, at least in your head.
##What do I explain how to do?
##How do I do that?
##What do HOWTO readers already know about doing that?
#Write up a good example. This ensures you can do it.
#Write up the steps to do it.
#Write the background info/prerequisites readers need.
#Write the summary.
#Clean up your work.
#Revise, revise, revise.

== See Also ==
Point your readers to related information they may refer 
further, as every information does not fit in your HOWTO.
Remember to add  both internal wiki links and external 
references.

Every page should be assigned at least one category.
So add relevant category to your page. 

参见