Article blueprints

Wiki Help pages
Contributor's guide — Guidelines — Fixing errors howto
Editing pages — Talk pages — Formatting
Code of conduct — Wiki project page — About Gentoo wiki — Wiki FAQ
Help improve the documentation! — Contributing to Gentoo

These blueprints have been created to provide contributors with convenient ready-made structures on which to base articles, to encourage consistency across the documentation.

Blueprints provide skeleton-code that editors can copy and paste as a foundation for creating new articles. Existing articles should be adapted to follow blueprints to improve their quality, as part of the editing process.

Blueprints both adhere to and are stipulated by the wiki guidelines (if necessary, please review those guidelines before creating or editing articles). Articles that don't have a corresponding blueprint should still try to take inspiration from the blueprints when appropriate.

Important
Articles should follow blueprint structure as much as reasonable, but not every article will neatly fit into the outline of a blueprint: adapt as appropriate, adding or removing sections as needed. Always delete unneeded blueprint content, including sections that are simply waiting to be written (for which the {{Todo}} template may be useful).

Note
After copy-pasting the blueprint, remember to remove the comments that are between the  tags. Be sure to replace any skeleton-code examples with appropriate content - letting blueprint example code slip through would confuse readers.

Tip
Take a look at well-formed preexisting pages to get ideas for laying out articles. Some section names are common across the wiki, even though they are not suggested by blueprints - it's good for consistency to reuse those section names when editing articles.

These are the available blueprints for documentation on the Gentoo wiki:

Article blueprints

Software

Hardware

Meta

Community

See also