--- GNU-Press-styleguide.texi 2003-06-09 13:49:03-04 1.1 +++ GNU-Press-styleguide.texi 2003-06-10 15:45:23-04 @@ -175,7 +175,7 @@ @item Put important notes to the reader in subsections of their own. -This tells the reader the notes really are important. +This tells the reader the notes really are important. While ``first things first'' usually applies, in some cases, the very end of a section is the best place for an important note, perhaps @@ -239,12 +239,38 @@ @item When you are explaining a feature of a program, it is often helpful to awaken the reader's interest by first outlining a problem the feature -solves or a need it fulfills. Write text that ``motivates'' the -reader to understand why the feature is needed. You should assume -that most people will not themselves think that they need the feature -ahead of time, and that when the feature is introduced, only the -really smart readers will figure out for themselves why it is a good -idea. +solves or a need it fulfills. Write text that ``motivates'' the reader +to understand why the feature is needed. Only the really smart readers +will figure out for themselves why a feature being introduced is a good +idea. You should assume that most people will not themselves think they +need the feature ahead of time. + address@hidden +Introduce the depth and scope of the material to be covered. Give overviews of what will be covered. Use this to make connectons between sections and help the reader progress through sections. + address@hidden +Give the reader an overview of the procedure before showing the actual procedure. + address@hidden +A commonly respected practice in programming is modularity, where +segments of code are organized into self-contained units (as opposed to +unorganized and overlapping ``spaghetti code''). These rules can also +apply to written documents. Documents benefit from being +well structured and written in well organized sections. A document +introducing concepts in independent sections is easier to read and +better serve as a reference for individuals looking for specific +concepts or features. + address@hidden +Well organized and modular free documentation, just like well organized +modular free software, is material that can more easily be maintained, +improved or even reused by others who wish to contribute to free documents. + address@hidden +Consider the order of your sections and the order of the text within sections. Types of order include difficulty, subject, procedurally and chronologically. Use the one that best serves how you wish to present the topic. + address@hidden + @end itemize @@ -257,7 +283,7 @@ @itemize @bullet @item -Give sample output for code examples wherever possible. +Show sample output for code examples wherever possible. @item Don't waste the reader's time with frivolous examples that have no @@ -409,6 +435,45 @@ @item Examples are not ``given'' but ``shown''. Only useful stand-alone programs qualify as gifts. + address@hidden +Avoid longer sentences in favor of multiple shorter sentences. + address@hidden +Use smaller words rather than longer. + address@hidden @bullet + address@hidden +There has to better examples than this.. address@hidden ignore + address@hidden +utilize - use + address@hidden +terminate - end + address@hidden +preceded - begin + address@hidden +specified - give + address@hidden itemize + address@hidden 1500 address@hidden +Use active voice rater than passive + address@hidden @strong address@hidden Bad: +``The input is read by the program'' + address@hidden Good: +``The program reads the input'' address@hidden table + @need 1500 @item