Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Documentation style guide 1

Documentation Style Guide Documentation Style Guide SUSE and openSUSE Publication Date Jun Version Revision Build Date June Legal Notice Copyright c Novell Inc Permission is granted to copy distribute and or modify this document under the terms of the GNU Free Documentation License Version or any later version published by the Free Software Foundation with the Invariant Section being Trademark Policy with the Front-Cover Texts being Documentation Style Guide and SUSE and openSUSE A copy of the license is included in Appendix B GNU Free Documentation License Disclaimer All information found in this book has been compiled with utmost attention to detail However this does not guarantee complete accuracy Neither Novell Inc SUSE LINUX Products GmbH the authors nor the translators shall be held liable for possible errors or the consequences thereof Trademark Policy Novell the Novell logo the N logo SUSE openSUSE and the SUSE ??gecko ? logo are trademarks and registered trademarks of Novell Inc in the United States and other countries Linux is a registered trademark of Linus Torvalds All other third party trademarks are the property of their respective owners Contents Creating a Consistent Structure Writing and Editing Creating Procedures Presenting Computer Elements doc opensuse org products opensuse Styleguide opensusedocumentationstyleguide sd C Entities Indexing Preparing Glossary Entries Spelling Terms Inserting Comments A Markup Conventions Documentation Style Guide A Use of Identi ?ers A The Book Structure A Block Structures A Inline Structures B GNU Free Documentation License B PREAMBLE B APPLICABILITY AND DEFINITIONS B VERBATIM COPYING B COPYING IN QUANTITY B MODIFICATIONS B COMBINING DOCUMENTS B COLLECTIONS OF DOCUMENTS B AGGREGATION WITH INDEPENDENT WORKS B TRANSLATION B TERMINATION B FUTURE REVISIONS OF THIS LICENSE B ADDENDUM How to use this License for your documents Abstract This document contains SUSE-speci ?c style and layout issues and writing guidelines It identi ?es and describes several issues to standardize the style of SUSE and openSUSE documentation This document also contains a reference part for the XML markup used by the SUSE editors and intended for openSUSE projects such as Lessons for Lizards This document refers to the following documents The Chicago Manual of Style th Edition doc opensuse org Nproodrumctsa opnenWsusae lSstyhle'gsuiDde oopcenBsuosoekdo cTumheentaDtiones ?tynleigtiuvidee sGd uide TDG C Documentation Style Guide Norman Walsh's DocBook The De ?nitive Guide TDG http www docbook org tdg en html docbook html Creating a Consistent Structure It is important to maintain a relatively consistent structure within a document This structure may vary for di ?erent books or projects For consistency each project should have its own guidelines o ?ered here in a separate project document or through templates Lessons for Lizards The standard base structure of LfL is re ected in its template Find the template in LfL's SVN The project is still in development stages Once the project is more stable guidelines will be added here O ?cial SUSE Manuals A SUSE manual consists of the following mandatory elements title page copyright notice table of contents preface and chapters split in