For the complete documentation index, see llms.txt. You can also append .md to any page URL to get its markdown version.
Skip to main content
For the complete documentation index, see llms.txt.

Behind our developer documentation

We are the people behind Signicat's developer documentation!

Meet the documentation team​

We are a small, cross-functional team of four technical writers, a designer and a platform developer. This mix of roles enables us to do everything from writing the actual guides to shaping how they look, feel and function.

What we do​

Our mission is to help you integrate with Signicat's products in a seamless way.

We turn complex technical information into documentation. Our responsibilities include:

  • Creating comprehensive API references, quick-start guides, integration guides and conceptual explanations.
  • Designing intuitive navigation, search and reading experiences.
  • Building custom documentation tools.
  • Collaborating with product and development teams across Signicat to ensure technical accuracy.

Our approach to documentation​

Good documentation helps developers find the right information, understand it quickly and put it into practice. For us, that means keeping things clear, accurate, accessible and focused on real developer needs. We aim to make our docs useful rather than simply comprehensive, and we continuously improve them based on feedback, product changes and how people actually use them.

Our documentation platform​

Behind every page is a modern documentation platform tailored for developer experience. We use:

  • Docusaurus to power our static site generation and React-based interactive components.
  • Redocly and OpenAPI to generate interactive API references from our OpenAPI specifications.
  • ESLint and Vale to automatically check for accessibility rules, frontmatter standards and editorial style guidelines.
  • Algolia search to index our content for fast search results as you type.
  • Kapa AI assistant to provide instant, conversational answers to your questions directly from our docs.

Our documentation process​

Good documentation is a team effort. We work closely with product and development teams to understand what needs documenting. Then we research, write, design, review, build and publish the content. Once published, we keep learning from feedback, product changes and how developers use the docs to make them better.

Our docs-as-code approach​

We treat documentation as code:

  • Our documentation process follows the same version control workflows we use for our software.
  • We write our content in Markdown (MDX) using IDEs (like VS Code).
  • Our automated CI/CD pipelines perform quality checks like linting or link checking before anything goes live.
  • Our developers create OpenAPI specifications and contribute directly to the documentation.

How we use AI​

We use AI to work smarter, but we always keep a human in the loop. Every single guide, API reference and code example is reviewed by a real person.

  • We have built our own internal documentation agent with specific skills to help us adhere to style and standards.
  • We provide an MCP server to let you connect your preferred AI tools with the Signicat developer documentation.
  • We maintain an llms.txt file at the root of our developer portal. This file provides a structured overview of our documentation in Markdown format. It is designed specifically for external LLMs to quickly read and understand our documentation.
  • We actively use AI code assistants directly in our editors to write Markdown, edit structure and components in the documentation platform.

How to contact us​

If you have questions, suggestions or feedback about the documentation, please contact us by creating a support ticket in the Signicat Dashboard.