The Source for Java Technology Collaboration


Home | Help | Changes | Index | Search | Go

WritingArticles

need to fill in following information:

  • Do not include copyrighted materials that belong to anyone else....

Creative Commons License
All articles in the Javapedia are licensed under a Creative Commons License.


Remember that a Wiki is a web page so that your writing style should be adjusted for the medium.
Language; writing for the web

People rarely read web pages (and possibly other electronic documents) word by word; instead they scan the page.

  • Summary first (at the top of the page). Adding a %TOC% helps too.
  • One idea per paragraph, summarized in the first few words or sentence.
  • Half the word count of conventional writing.
  • Highlighted keywords. Highlighting can be achieved by hypertext links, and changes in typeface or color. A [[WikiLink]] works well. eg: WikiLink?
  • Meaningful section headings, not clever ones (the heading conveys useful information). Use ---+!! text to create sections.
  • Bulleted lists
  • Objective, neutral language. Users detest marketing or promotional language, and it has been shown to slow them down.
The above was adapted from Web Page Design from the KDE project.

The visual structure of a page is a tool you can use to help people find information they want to read. Long flowing blocks of text do not help the user find the information they want in the least amount of time. Make use of the TextFormattingRules link on the edit page.



Discussion about WritingArticles

Topic WritingArticles . { Edit | Ref-By | Printable | Diffs r4 < r3 < r2 < r1 | More }
 XML java.net RSS

Revision r4 - 25 Jun 2003 - 05:54:44 - Main.leknor
Parents: WebHome