Style Guide
This guide outlines the writing style and formatting conventions for the Crusaiders documentation.
1. Tone and Voice
The tone of the documentation should be a mix of formal and casual. It should be informative and professional, but also engaging and easy to read. Avoid using overly technical jargon, and explain complex concepts in a clear and concise way.
2. Formatting
Please adhere to the following formatting conventions when writing documentation:
- Headings: Use headings to structure your content and make it easy to scan. Use H1 for the main title, H2 for major sections, and H3 for subsections.
- Code Blocks: Use code blocks to display code examples. Be sure to specify the language of the code block for syntax highlighting.
- Emphasis: Use bold and italics to emphasize important words and phrases.
3. Terminology
When referring to game-specific terms, please use the following conventions:
- Agent: Always capitalize the word "Agent."
- Dojo: Always capitalize the word "Dojo."
- Ladders: Always capitalize the word "Ladders."
4. Conclusion
By following these guidelines, you can help us maintain a high standard of quality for the Crusaiders documentation. We appreciate your contributions and look forward to working with you.