Documentation/Checklist

Documentation checklist

Work-in-progress

When you write documentation, use this checklist to ensure quality.

Task	Description	Complete?
pom.xml file	Make sure that your pom.xml file uses the latest cloud-doc plugin and is configured correctly.
Spellcheck	Oxygen has a spellchecker. You can spellcheck all files in a book by choosing
Glossary	Embed the shared glossary and mark terms with the <glossterm> tag in your document.
Doc conventions	Ensure that your content uses the recommended doc tagging.
Preface	Make sure the book has a preface.
Doc history	Make sure the preface includes the doc history. Also make sure that you have included a revision entry for your latest changes.
Title	Is the title correct? Look here for the official titles (add link).
Code samples	Make sure code samples are in separate files.
Example	Example	Example
Example	Example	Example