Loading…

JasPing Logo

Writing style guide

How to write docs that look good and stay consistent.

<p>This style guide helps your documentation look consistent across pages and languages.</p> <h2>Page template</h2> <ol> <li>Definition (1 paragraph)</li> <li>Key takeaways (bullets)</li> <li>Steps (numbered list)</li> <li>Examples (short)</li> <li>FAQ (2–5 questions)</li> </ol> <h2>Consistency checklist</h2> <ul> <li>Use the same names for plans, channels, and features.</li> <li>Do not contradict other pages.</li> <li>Link to the source of truth when possible.</li> </ul> <h2>Visual formatting</h2> <ul> <li>Prefer H2/H3 headings</li> <li>Use tables for comparisons</li> <li>Use blockquotes for tips and notes</li> <li>Keep paragraphs short</li> </ul>