Translations:Documentation/DocumentationTeamInfo/ProducingLibreOfficeUserGuides/84/en

From The Document Foundation Wiki
Jump to: navigation, search
  1. Make sure the correct template is applied to the chapter; sometimes we change templates between releases (for example, between LibreOffice 4.x and 5.x).
  2. Go through the instructions in the chapter. Follow the instructions exactly as they are written, so you can see if anything is different between the instructions and the software or if any essential steps are missing or unclear.
  3. Pay close attention to the screenshots. If anything is different, make a note of it. If you can capture new screenshots, then you can replace the out-of-date ones with up-to-date ones. If you cannot capture new screenshots, then leave a comment in the file that Figure x needs to be replaced. Note that some minor differences in appearance may exist between dialogs in Windows, Linux, and macOS.
  4. Ensure that the text and the illustrations (such as screenshots) agree with each other. For example, sometimes the name of an option is changed in the program (and thus in a new screenshot), but the writer fails to change the name in the text.
  5. Please also suggest other topics that should be included in the chapter, or better ways of explaining things, or any other improvements you can think of. These might include adding topics or examples (or creating stand-alone tutorials or how-tos and referring to them from the user guide), revising topics to make them more useful, or reorganizing chapters (either moving topics within a chapter or, in some cases, moving material from one chapter to another).
  6. Be aware that in some cases a topic may be covered in another chapter; in that case a cross-reference would be helpful, or in some cases duplicating some information might be the best solution.
  7. Check that the paragraph and character styles used are correct (see Chapter 5, Using the Chapter Template). Check the spelling.