Team 1432:Style Guide

From the Team 1432 Robotics Wiki

This brief guide contains information to be used when editing the wiki. The Wikipedia Manual of Style should also be considered. However, the main skill to use when editing pages is common sense.

Purpose

• Be welcoming. This wiki exists for people to read it. New team members will be referred to it, and visitors will see it as well. The most prominent pages should be readable by anyone, yet still contain detailed information and content for both FIRST participants and non-participants.
• Be thorough. We do also want information that may only be useful to our team, such as IT Infrastructure, for our internal use and organization. Pages should contain information that is relevant to FRC and useful to members. New members should be able to learn from the content. For example, the page about LabVIEW has some information for people who may be trying to learn to use LabVIEW; it does not go into extreme detail, but also does not skimp on useful content. As another example, the Robot 6 page contains an overview of the function of the robot, as well as a link to a page about its program, Safe, which has a detailed description of some functionality and implementations.
  • At the same time, the wiki is not intended to replace Wikipedia or any other encyclopedic source. As such, it should not contain an endless series of definitions and detailed descriptions of common terms. However, it is encouraged that pages link to Wikipedia (using the interwiki syntax [[wikipedia:Page Name|link text]]) for more information that is not necessarily relevant to the team.
• Write professionally. The wiki should reflect the team as a whole as well as its members. Don't use superfluous formatting or language that is too casual. If you can not think of an appropriate wording for the content of a page, consult another team member or post a message on its discussion page. Please make sure to check your spelling and grammar as well.
  • Be consistent. Try to keep the tone, tense, cadence, and formatting of a page consistent throughout that page and across the entire wiki, where possible and appropriate. When in doubt, look around at other previously existing pages. Older pages, which have existed for a while and have been subject to editing by different people, are likely to reflect the desired style and format.

Robot pages

Each robot has its own namespace. Robot pages should provide information about any relevant history of the robot, its capabilities, construction, and control system. More detailed information, such as wiring diagrams, should be in separate pages within the robot's namespace. Pages about robot programs should be in the main namespace, as they may be used by or relevant to more than one robot.

Robot pages should make use of the Robot infobox template to show standardized information about a robot along with a photo. Information about the syntax of this template is available on the template page. Old robots which have since been taken apart should also use the old robot template.