InfoQ Homepage Documentation Content on InfoQ
-
/articles/generative-ai-software-project-management/en/smallimage/GettyImages-1486987406-small-1718624134447.jpg)
Using Generative AI in Software Project Management to Bridge Domains and Accelerate Productivity
Gen AI Assistants play to the strengths of professionals with a breadth of experience, particularly software developers who can describe what they want the LLM to complete and critically evaluate the result. These tools enable us to swiftly cross divides of domain language and scale large repetitive tasks down to interesting ones on a human scale.
-
/articles/organizational-resilience-documentation/en/smallimage/building-organizational-resilience-through-documentation-and-InnerSource-small-1702890930736.jpg)
Write More, Talk Less: Building Organizational Resilience through Documentation and InnerSource
Better documentation and knowledge sharing creates transparency that aids onboarding, prevents turnover disruption, and withstands reorganizations. Different practices can help, such as communicating asynchronously, creating incentives for documentation, making docs discoverable, understanding team members' preferences, and providing dedicated writing time. And maybe InnerSource can help too.
-
/articles/continuous-documentation-workflow/en/smallimage/logo-1643979958969.jpg)
From Couch to Continuous Documentation: Incorporating Documentation into the Development Workflow
As software teams and projects grow, they suffer from knowledge management pains related to their code - lengthy onboarding, limiting knowledge silos, complex code, and risk of attrition. Creating Walkthrough Documentation while practicing Continuous Documentation can address most of the problems that relate to code-related knowledge sharing and management.
-
/articles/code-walkthrough-documentation/en/smallimage/logo-1636129739776.jpg)
The Renaissance of Code Documentation: Introducing Code Walkthrough
The Continuous Documentation methodology is a useful paradigm that helps ensure that high-quality documentation is created, maintained, and readily available. Code Walkthroughs take the reader on a “walk” — visiting at least two stations in the code — describe flows and interactions, and often incorporate code snippets.
-
/articles/continuous-documentation/en/smallimage/SWIMM-s-1622628522688.jpg)
Shifting to Continuous Documentation as a New Approach for Code Knowledge
Documentation is an important part of code development. However, documentation quickly becomes stale as code changes. Continuous documentation focuses on three principles: continuously verifying documents, documenting when it is most needed, and coupling the documentation to the code.
-
/articles/book-review-living-documentation/en/smallimage/livinig-documentation-cover-s-1568792232451.jpg)
Q&A with Cyrille Martraire on the Book Living Documentation
Cyrille Martraire argues that we should rethink how we work with documentation when building software systems — we should embrace documentation that evolves at the same pace as the code. In the book, he describes the concepts and ideas that are the base for living documentation and uses practical examples on how documentation that is always up-to-date can be created.
-
/articles/openapi/en/smallimage/open-api-s-1560967631428.jpeg)
Using OpenAPI to Build Smart APIs for Dumb Machines
This article discusses how to build, manage and maintain APIs with OpenAPI, including some of the most notable features in v. 3.0.
-
/articles/why-architectural-diagrams/en/smallimage/why-architectural-diagrams-s-1547639074677.jpeg)
Why Do We Need Architectural Diagrams?
Software architecture diagrams, when created well, and sparingly, can greatly improve communication within the development team and with external stakeholders. They require an understanding of the intended audience, and thoughtful restraint on what to include. Resist the temptation to think that diagrams are unnecessary or unhelpful, simply because there have been plenty of cases of bad diagrams.
-
/articles/TOGAF-enterprise-architecture/en/smallimage/togaf-logo-small-1536250135544.jpg)
How the TOGAF Standard Serves Enterprise Architecture
Any architect working with large enterprise systems has probably looked for guidance on how to manage the complexity and communicate with various stakeholders. This introductory overview of the TOGAF standard explains the structure of the framework, as well as discusses the benefits of using enterprise architecture to manage complex systems.
-
/articles/ci-rest-docs/en/smallimage/logo1.jpg)
Always Be Publishing: Continuous Integration & Collaboration in Code Repositories for REST API Docs
API documentation is an often overlooked part of making any API a success. This article explores how to make the documentation part of a continuous integration pipeline keeping it closer to the code itself.
-
/articles/document-description-formats-web-apis/en/smallimage/web-apis.jpg)
Virtual Panel: Document and Description Formats for Web APIs
In this virtual panel we hear from 4 individuals deeply involved in the Web API space. Each of them has a unique take on the values, benefits, and costs of documentation and description formats in general, and provide their own unique perspective from their vantage points across the Web. They agree on one thing: something must be done to help developers find their way through the world of Web APIs
-
/articles/towards-agile-software-architecture/en/smallimage/logo.jpg)
Towards an Agile Software Architecture
Boyan Mihaylov covers his experience when working with both traditional waterfall software architectures and agile ones. He depicts the similarities and differences between these with a focus on three areas: the specifics of the software architect role, the timespan of the software architecture, and the output of the software architecture.