Formatting Rules & Editorial Guidelines
This document outlines the mandatory formatting standards for all submissions to InkWell. Adhering to these rules ensures consistency, accessibility, and optimal readability across our publishing platform.
1. Typography & Headings
Maintain a strict heading hierarchy. Never skip levels (e.g., jump from H2 to H4). Use semantic heading tags to structure your document logically.
Heading Specifications
2. Paragraphs & Spacing
Keep paragraphs focused and concise. Avoid walls of text that reduce scannability on digital screens.
- Line Length: Maximum 65–75 characters per line for optimal reading speed.
- Line Height: 1.65 (handled automatically by the renderer).
- Spacing: Single blank line between paragraphs. Do not use manual `
` or double spacing.
3. Lists & Structure
Use lists to improve scannability. Follow these rules for consistency:
| Type | Usage | Max Depth |
|---|---|---|
| Unordered (`-` or `*`) | Non-sequential items, features, steps without order | 2 levels |
| Ordered (`1.`) | Procedures, rankings, chronological sequences | 2 levels |
| Definition (`:`) | Glossary terms, key-value pairs | 1 level |
4. Images & Media
All media must be optimized for web delivery and include descriptive attributes.
Media Requirements
Decorative images should use `alt=""` for screen readers. Logos and brand assets must link to their official source when applicable.
5. Links & Citations
Hyperlinks should be contextual and use descriptive anchor text. Avoid generic phrases like "click here" or "read more".
Citations: Use markdown footnotes for academic or data-heavy references.
According to recent studies[^1], user engagement increases significantly...
[^1]: Smith, J. (2023). Digital Reading Patterns. Journal of UX Research, 12(4), 45-62.6. Code & Technical Blocks
Inline code and block code require language specification for syntax highlighting. Fenced code blocks must include the language identifier.
\`\`\`javascript
// Correct usage
const formatDate = (date) => new Date(date).toLocaleDateString();
\`\`\`
\`\`\`python
# Correct usage
def format_date(date):
return date.strftime("%B %d, %Y")
\`\`\`Always use the standard markdown backtick syntax. Do not use HTML `` or `` tags unless explicitly required by legacy migration.
7. Tone & Voice Guidelines
InkWell's editorial voice is authoritative, approachable, and inclusive. Follow these principles:
- Active Voice: Prefer active constructions. (e.g., "The system processes data" vs "Data is processed by the system")
- Clarity Over Cleverness: Prioritize precision. Avoid jargon unless defined.
- Inclusive Language: Use gender-neutral terms. Avoid idioms that may not translate across cultures.
- Consistency: Match the section's technical level. Don't mix beginner explanations with advanced implementation details without clear transitions.
8. Submission Checklist
Before publishing or submitting a draft, verify the following:
Submissions that fail formatting validation will be returned to the author for revision. The editorial team prioritizes structural compliance before content review.