Sphinx and the QuTiP Developers' Guide
A developer's guide to using Sphinx documentation tools for the QuTiP quantum physics library, written as part of a Google Summer of Code project.
A developer's guide to using Sphinx documentation tools for the QuTiP quantum physics library, written as part of a Google Summer of Code project.
A guide for beginners on how to efficiently navigate and find answers in the extensive Django documentation, reducing frustration.
Explains how using RFC (Request for Comment) documents can improve asynchronous communication and decision-making in tech teams.
Tips for improving writing effectiveness, including organization with headers and using images, with examples from tech documentation.
Explains the importance of documenting unit tests with examples and best practices for writing clear test comments.
Explains how comprehensive documentation encourages open source contributions, using Gatsby.js as a case study for sustainable project growth.
A technical guide on using type-safe code generation to prevent broken documentation links in software projects, ensuring compile-time validation.
Explains how to contribute to and improve software documentation through community editing platforms like GitHub, using Microsoft and VMware examples.
A developer shares a personal story about fixing a documentation error in an open source Gatsby plugin, emphasizing that all contributions are valuable.
Practical tips for writing clear, readable technical documentation and notes, focusing on structure, formatting, and user psychology.
A developer shares a story about patience in open source, detailing a 7-month-old pull request to improve documentation for the freeboard dashboard project.
A developer outlines key criteria for selecting a Content Management System (CMS), prioritizing client needs, documentation, and user interface.
A guide on contributing to open source projects by improving documentation, using a Node.js library example.
A guide encouraging developers to contribute to open-source projects like AngularJS by improving documentation, not just code.
A developer shares their experience contributing to Docker's official documentation by fixing a Windows-specific path issue in the config.json file guide.
A tech consultant explains why clear, professional writing is a critical skill in IT, covering grammar, context, and documentation.
A tutorial on integrating Swagger UI documentation into a .NET Core Web API project using Swashbuckle.
A talk arguing for the importance of code comments, debunking common arguments against them and providing a framework for effective commenting.
A developer's summary of their contributions to the Rust programming language during the IDA Summer of Code 2014, focusing on documentation and code fixes.
Discusses the importance of meeting scribing and documentation as a company scales, offering practical tips for effective note-taking and communication.