XSI-Wiki:Writing style guide
The objective of this site is to be a valuable resource for professionals. This implies providing quality content with a high signal-to-noise ratio and focusing on information that adds real value. Here are some general guidelines:
- Be visual. Add diagrams, graphs, charts, images, movies and whatever else you think will get your point across.
- Be concise. Write what people need to know. Keep it short and to the point. Avoid clutter.
- Be focused. Zoom in on the stuff that really matters, and keep each topic focused. Have tons of ideas? Add them in tons of appropriate places and add links.
- Be specific. Add as much specific information as you can to help others to quickly get results. List the exact settings you use.
- Give examples. Make sure you include examples for complex descriptions or highly abstract concepts. It helps others to get there faster.
[edit]
Page Templates
To provide well-structured content, we've developed the following templates for certain types of pages. Please use them when adding new content of a relevant type:
- Template for Product Main Pages
- Template for Alphabetical Index Pages - example: a glossary
- Template for Category Pages
- Add new templates here.
This page was last modified 00:25, 27 Oct 2005.
This page has been accessed 1115 times.
