Manual of Style: Difference between revisions
U080F22CTJN (talk | contribs) created style guide adapted from the wiki.hackclub.com one at github.com/hackclub/wiki |
U080F22CTJN (talk | contribs) active review disclaimer |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
''<big>This manual is currently under active review!</big>'' | |||
This guide covers how to write and format articles for the Hack Club Wiki. | This guide covers how to write and format articles for the Hack Club Wiki. | ||
| Line 6: | Line 8: | ||
* A clear title (H1, auto-generated from frontmatter) | * A clear title (H1, auto-generated from frontmatter) | ||
* An intro paragraph — one or two sentences explaining what the article is about | * An intro paragraph — one or two sentences explaining what the article is about | ||
* Organized sections with H2/H3 headings | * Organized sections with <code>==H2==</code>/<code>===H3===</code> headings | ||
* Links to related articles using [[WikiLink]] syntax | * Links to related articles using <nowiki>[[WikiLink]]</nowiki> syntax | ||
== Tone == | == Tone == | ||
* Clear and direct | * Clear and direct: write for a high schooler who's new to Hack Club | ||
* Friendly, not formal | * Friendly, not formal: we say "you" not "one" | ||
* Active voice | * Active voice: "Hack Club ships stickers" not "stickers are shipped" | ||
* No jargon | * No jargon: or explain it when you use it | ||