Skip to main content

Technical Writing

Technical Writing​

Welcome to the Workflows section of the Clarus documentation. We understand that as a developer, engineer, or fellow technical writer, you need documentation tools that actually help you produce clear, usable guides, READMEs, and documentation. That’s our focus at Clarus: docs, guides, and READMEs that are actually clear.

Here’s how Clarus supports your technical documentation workflow.

Your Docs, Your Way

Unlike many tools, Clarus is completely markdown-native. Forget messy conversions. What you write here is the markdown you’ll publish. This means full compatibility with your preferred tools: Astro, Hugo, Gatsby, Jekyll, Next.js, Eleventy, and more. We also support optional YAML front matter. You maintain complete data ownership – your documents are simply plain .md files.

Structure & Clarity First

We recommend a straightforward workflow:

  1. Structure First: Before you begin, lay out the entire structure of your document. Use <h2> and <h3> headings to clearly define each section. This keeps you organized and helps readers scan for relevant topics.
  2. Explain, Then Instruct: When documenting a procedure, always start by explaining why someone needs to do something, then detail how. Providing context drastically improves comprehension.
  3. The Clarity Check: Our Writing Coach. This is where Clarus shines. The integrated Writing Coach isn’t interested in grammar. It’s interested in clarity. The coach assesses whether your explanations are easily understandable. If the coach flags something, it's a signal your readers will likely struggle too.
  4. Export & Publish: Once reviewed, simply export your document. Because everything's already markdown, you're ready to publish.

The Right Kind of Feedback

The Writing Coach adapts to technical content. You won’t get suggestions about “varying your sentence structure” while documenting numbered steps. Instead, it will identify points where your explanation is ambiguous, incomplete, or just plain confusing. It's designed to help you avoid clarity failures – the biggest issue in technical documentation.

Collaboration & Review

Need feedback? Our Track Changes functionality lets you easily share drafts, receive suggestions, and monitor exactly what changes were made during the review cycle.

Ready to get started? Focus on building excellent content, and let Clarus handle the details.