<<SOURCEFORGE | PROJECT PAGE>>
FreeDOS documentation project logo
 
Edit Page - Page History - Printable View - Recent Changes - WikiHelp - SearchWiki - PageDown
C:\FdDoc\FdDocEn\SideBar
C:\FdDoc\FdDocEn\GetStarted

FREEDOS HOWTO Start

jhall @-sign freedos.org

GNU Free Documentation License


The following was based on The Linux HOWTO

Index by Greg Hankins (email: gregh @-sign sunsite.unc.edu) as of v2.10.63, 24 March 1998.

If you are interested in writing a HOWTO or mini-HOWTO, please get in touch with the FreeDOS Documentation Project coordinator first (see addr in footer). Here are a few guidelines that you should follow when writing a HOWTO or mini-HOWTO:

Try to use meaningful structure and organization, and write clearly. Remember that many of the people reading HOWTOs do not speak English as their first language.

If you are writing a HOWTO, you must use the wiki and learn some of the TipsForEditing and also TextFormatingRules. Grab the template and start from there. This gives all of the HOWTOs a uniform look. It is very important that you format and review the output of your HOWTO.

Make sure that all of the information is correct. I can’t stress this enough. When in doubt, speculate, but make it clear that you’re only guessing. Make sure that you are covering the most recent version of the available software. Also, be sure to include full instructions on where software can be downloaded from (FTP site name, full pathname), and the current version number and release date of the software.

Include an FAQ section at the end, if appropriate. Many HOWTO documents need an FAQ or Common Problems section to cover information which can’t be covered in the regular text.

Use other HOWTOs or mini-HOWTOs as a model! Make sure that your name, email address, date, and a version number is near the beginning of the document. You could also include WWW addresses and a snail mail address if you want.The standard header is:

 FreeDOS HOWTO Start

 Jhall

 GNU Free Documentation License 
 ----

Before the GNU License, include the following.

 Translator : Luis Xavier lx@somewhere.someplace.com - 05/10/2002 
 Revisor : James Batista JB@somewhere.someplace.com - 05/23/2002 

Every HOWTO should include a copyright statement, like the following:

 GNU Free Documentation License ( http://www.gnu.org/copyleft/ ) 

 Copyright © {Year} - {Your name as an author}

 Permission is granted to copy, distribute and/or modify this document under the   
 terms of the GNU Free Documentation License, Version 1.1 or any later version   
 published by the Free Software Foundation; with no Invariant Sections, with no  
 Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is 
 included in the section entitled GNU Free Documentation License. 

Lastly, be prepared to receive questions and comments about your writing. After you have written the HOWTO, put it in the Document Manager at Source Forge. Your HOWTO will be read, revised and finally aproved if it is ok.

It is important that you go through the FD-DOC coordinator when submitting a HOWTO, as we maintain the archives and need to keep track of what HOWTOs are being written and who is doing what.

Then, all you have to do is send in periodic updates whenever appropriate.


  • Revisor : Carlos Alberto Bonamigo <carlos.ab @-sign gmail.com> - 09/23/2004
  • Revisor : Carlos Alberto Bonamigo <carlos.ab @-sign gmail.com> - 12/15/2004

GNU Free Documentation License ( http://www.gnu.org/copyleft/ )

Copyright © 2001- Jim Hall

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled GNU Free Documentation License.

Edit Page - Page History - Printable View - Recent Changes - WikiHelp - SearchWiki - PageUp
Page last modified on June 19, 2009, at 10:12 AM
E-mail the coordinator at freedos-documentation @-sign freedos point org
This site is part of the FreeDOS Project.
SourceForge.net Logo