InfoQ Homepage Documentation Content on InfoQ
-
Cloudflare Open Sources Documentation and Adopts Astro for Better Scalability
Cloudflare recently published an article detailing their upgrade of developer documentation by migrating from Hugo to the Astro ecosystem. All Cloudflare documentation is open source on GitHub, with opportunities for community contributions.
-
JetBrains Launches IntelliJ-Based Writing Tool WriterSide
With WriterSide, JetBrains aims to allow developers and writers to create technical documentation using a write, test, build workflow. The new tool is based on IntelliJ-platform IDEs and has been used to create most of JetBrains products' documentation for the last few years.
-
AWS Shifts Strategy: Public GitHub Documentation to Be Retired
In the next few days, AWS will start retiring the AWS documentation currently available on GitHub. After reviewing the results of the project and considering the overhead of manually keeping the internal documentation in sync, the cloud provider recently decided to retire most of its public repositories.
-
Promoting Empathy and Inclusion in Technical Writing
Empathy is the first step in practicing sustainable, genuine inclusion. If persons or groups of people feel unwelcome because of the language being used in a community, its products, or documentation, then the words can be changed. Identifying divisive language can help to make changes to the words that we use.
-
Words Matter in Documentation to Build Better User Experience
The language that we use in our products or documentation can make people feel unwelcome or hurt people. We can choose words that are precise, not dependent on complex metaphors, and convey messages without negative connotations.
-
Compilation Meets Documentation: OpenJDK JEP-413
A new Java proposal offers a way to enhance API documentation through compilable source snippets.
-
Yari, the New MDN Web Documentation Platform
Mozilla Developer Network (MDN), Mozilla’s multilingual resource for web documentation, recently launched Yari, MDN Web Docs’ new platform. Yari reduces the burden of developing, maintaining, and contributing to MDN. MDN content is now stored in GitHub and can be contributed to via pull requests.
-
New MDJS Markup Language Adds JavaScript to Markdown for Interactive Documentation
Thomas Allmer, founder of Open Web Components (@OpenWc), released MDJS, a Markdown variant that allows developers to include runnable JavaScript code into their Markdown documents. MDJS can be interpreted as regular Markdown content or be progressively enhanced to produce interactive documentation including web components.
-
The Swift Method: A Framework for Software Modernization Using DDD
The Swift Method is a set of techniques for analyzing complex legacy systems, and determining the work required to gradually modernize key components or the whole system.
-
Interactive .NET Documentation with Try .NET
Recently Microsoft open-sourced Try .NET, an interactive documentation generator for .NET Core. Similarly to equivalent tools targeting different programming languages (such as Jupyter), it produces documentation that can contain both explanatory text and live, runnable code.
-
Amazon Enters Enterprise Content Management Space, Announces General Availability of Textract
In a recent press release, Amazon announced the general availability of Amazon Textract, a fully managed, machine learning service that extracts content from text and structured document data. Using Amazon Textract, customers can automate document workflows, index and catalog important information for use in downstream applications.
-
Bringing Intelligence to Enterprise Content Management, Google Releases Document Understanding AI
At the recent Google Cloud Next Conference, Google announced a new beta machine learning service, called Document Understanding AI. The service targets Enterprise Content Management (ECM) workloads by allowing customers to organize, classify and extract key value pairs from unstructured content, in the enterprise, using Artificial Intelligence (AI) and Machine Learning (ML).
-
Google Launches "Season of Docs" Program to Improve Open Source Documentation
Google has launched Season of Docs, a program which aims to improve documentation for open source projects. It will do this by building a mentoring relationship between open source contributors and technical writers, helping create stronger and more comprehensive documentation for various open source technologies.
-
TSDoc: A TypeScript Source Code Documentation Format
TSDoc proposes a new format for documenting TypeScript source code. Existing TypeScript API documentation parsers accept a syntax based on JSDoc, but the extensions to JSDoc are inconsistent across implementations.
-
Microsoft, Google, and Mozilla Team Up for Web Documentation
In a coordinated announcement, three major browser vendors have agreed to consolidate their individual web API reference documentation into Mozilla's MDN and have formed an advisory group to guide future efforts. The groups will start using MDN as a single point of truth for web platform documentation and reference.