> For the complete documentation index, see [llms.txt](https://40factory.gitbook.io/wilson/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://40factory.gitbook.io/wilson/3.11/guidelines-for-document-preparation.md).

# Guidelines for Document Preparation

### Text Layout: 

* Use a single-column format. 
* Stick to one language throughout the document. 

### Document Orientation: 

* Ensure the document is vertically oriented for consistency. 

### Hierarchical Structure: 

* Maintain a coherent hierarchical structure throughout the document, using chapters, paragraphs, and sub-paragraphs consistently. 

### Code and Tables: 

* Place code snippets on the same page for easier readability. 
* Whenever possible, keep tables entirely on one page. 
* Consolidate related information into a single table rather than splitting across multiple tables. 
* Avoid using symbols (e.g., checkmarks) in tables without accompanying descriptions. 
* Refrain from using background colors in tables, as they can hinder parsing. 

### Images: 

* Include captions for all images and ensure activity descriptions appear on the same page as the image. 
* Align images consistently with the page orientation. 
* Add detailed captions that specify the name, code, or identifier of the depicted component, especially if the same component appears multiple times in the document. 
* Cross-reference image details in the text, providing appropriate descriptions. 

### Export Format: 

* Export the document in PDF format, optimized for printing (PDF/X). 

### Attachments: 

* Avoid including attachments (e.g., diagrams, drawings) that do not provide additional information beyond the main document. 

### Navigation Elements: 

* Do not include side navigation bars or progress bars. 

### Notes and Annotations: 

* Place notes at the end of paragraphs instead of within the main body of text to maintain flow and avoid interruptions.