F4 Wiki:Style Guide
From F4 Wiki
More actions
F4 Wiki authoring style guide
This guide keeps pages consistent across authors. Use it for all new pages.
Required building blocks
- Use Template:Author Credit at the top of every page.
- For GD&T reference pages, use Template:GDT Infobox.
- For F4 behavior pages, use Template:F4 Behavior callouts for rules, warnings, and errors.
- Keep terminology consistent with the glossary and the F4 app.
GD&T reference page structure
- Summary (1 to 3 sentences)
- Definition
- When to use it
- Examples
- Common mistakes
- Related pages (link to matching F4 validation page)
F4 behavior page structure
- Summary (1 to 3 sentences)
- Validation rules (bulleted list)
- Warnings and errors (use Template:F4 Behavior)
- Examples (realistic, concise)
- Related pages (link back to the GDT page)
Tone and formatting
- Prefer short paragraphs and bullets.
- Keep headings concise and predictable.
- Use callouts only for exceptions or critical behavior.
- Avoid duplicating the standard reference inside F4 pages; link to the GDT page instead.
Page checklist (author)
- Author credit included.
- Required sections present.
- Examples are concrete and minimal.
- Cross-links between GDT and F4 pages present.