Image

Technical Writing

Create documentation that developers love to read, and teams love to maintain.

Quansight’s expert technical writers, developer relations, and developer experience engineers partner with your engineering and product teams to develop a targeted documentation strategy, high-quality content, and maintainable infrastructure. With experience working on dozens of documentation projects including open source software documentation for NumPy, SciPy, Jupyter, and conda-forge, our services follow the highest tried-and-tested standards for software documentation.

Structured, scalable documentation strategies that ensure accuracy, usability, and long-term maintainability.

  • Technical content development
    • Authoring user guides, developer guides, reference and architecture documentation, interactive tutorials and examples, as well as open source community and governance documentation.
    • Ensuring clarity, consistency, accessibility, and accuracy across all the documentation resources.
    • Structuring documentation for readability with concise pages, adequate cross-references, and intuitive navigation paths.

       

  • Documentation infrastructure setup
    • Selecting and setting up a documentation software framework and hosting medium that suits your team’s skillset and workflows.
    • Implementing docs-as-code practices with continuous integration and deployment (CI/CD), versioning, and documentation previews.
    • Including tests for checking spelling, language, and links, and executing embedded code snippets.
    • Auto-generating API references, and optional support for interactive (i.e., executable) documentation, and translations for broader reach.
    • Ensuring maintainability at every stage and documenting the infrastructure setup.

       

  • Documentation site and content audit
    • Reviewing the information architecture, scalability, and maintainability of your content and infrastructure.
    • Delivering a concrete assessment along with a proposal for improvements.

       

  • Themes and plugins
    • Designing and developing custom themes for the documentation website that align with your brand
    • Developing software-specific plugins, for example to render plots or outputs within the documentation.

       

  • Strategy and training
    • Working with your team on a strategy and workflows that enables regular updates and organic growth of your documentation.

About Quansight

Quansight is a consulting firm dedicated to the sustainable health of the open source ecosystem. We partner with enterprises and all types of organizations to help them safely leverage open source software for innovation and value. Simultaneously, we ensure this engagement supports the long-term resilience and sustainability of the projects they depend on.

Get in Touch

Ready to take the next step in your open source journey? We’d love to hear from you.
Contact Us
Image