Linhas gerais para a edição do manual do usuário Freespire

From Freespire

Jump to: navigation, search
Manual do usuário Freespire
Página principal-->Outros idiomas-->Português-->Linhas gerais para a edição do manual do usuário Freespire

Editing Guidelines for the Freespire User Manual

The Freespire User Manual Project is underway! I have designed a basic table of contents. Some of this will cross reference to material already on the WIKI and other parts can be incorporated to other parts of the WIKI. There are some minor ground rules that I request people to adhere to. I went through all my Basic to intermediate Linux books and several other wiki projects for ideas to form a basic table of contents. As the categories gain entries they will also be entered in an advanced ToC...or subcategories. You can find the basic ToC at Freespire User Manual.

  1. If you change content that already exists(other than spelling, grammar, syntax or format errors), please enter the reason for changes in the discussion tab. I will not reverse changes without discussion with the one who changed it. If a Leadership board member, Community board chair, or Technology board chair makes a change, I will consider that to be "dogma" save for basic spelling/grammar/syntax changes.
  2. When making an addition, please provide a link back to the table of contents and advanced table of contents and label it "To Freespire User Manual Table of Contents" and "To Freespire User Manual Advanced Table of Contents"
  3. Before making an edition to the Table of Contents, see if your topic would fall into one of the categories in the Table of Contents and add it to the Advanced Table of Contents. For Instance, Firefox would be better suited in the Internet Chapter and the Internet Software Chapter.

I do realize that with an advanced Table of Contents this will require some double entry/linking in some respects, I also realize the search feature can be used as opposed to a index. The logic for this is two fold.

  1. I would like everyone to be within 3 clicks at the most to get the information they need.
  2. There are some who are new to WIKI's and web based help and I would like to make it as "book like" as possible to those people while making it as user friendly to WIKI fans as possible.

Areas of editing need.

I will do my utmost to follow the growth of the manual, but we need everyone's help to make sure the table of contents and advanced table of contents is correct. The Index will be a useful tool to newbies, feel free to keep and eye out for key terms. For instance, if you see a lot of mail list or forum queries about wireless, make an entry in the Index for Wireless in the manual with a brief description of what it resolves (Wireless configuration, WEP Key, Hardware, etc).

I hope that what I entered is a good start. I have to attend to a meeting shortly and then run some errands, I will be back on the WIKI later to put in some entries to the introduction/how to use the manual later this evening.

Cheers!

Patrick

Personal tools