TechRepublic: IBM creates an open source tool to simplify API documentation

TechRepublic: IBM creates an open source tool to simplify API documentation. “APIs are essential to programming, but they can get complicated. IBM has launched a new tool for developers that should make writing API documentation a bit easier: The OpenAPI Comment Parser. ‘Developers need instructions on how to use your API and they need a way to try it out. Good documentation handles both,’ IBM developer advocate Nicholas Bourdakos said in a blog post about the new developer tool.”

BetaNews: New platform simplifies the creation of interactive online guides

BetaNews: New platform simplifies the creation of interactive online guides. “A new platform called Stonly seeks to let anyone create easy-to-follow guides called ‘Stonlies’ without any need to write code. Content including text, images and videos can be combined with interactive capabilities to ensure the viewer only gets relevant information.”

Announcing Docsy: A Website Theme for Technical Documentation (Google Open Source Blog)

Google Open Source Blog: Announcing Docsy: A Website Theme for Technical Documentation. “Docsy builds on existing open source tools, like Hugo, and our experience with open source docs, providing a fast and easy way to stand up an OSS documentation website with features specifically designed to support technical documentation. Special features include everything from site navigation to multi-language support – with easy site deployment options provided by Hugo. We also created guidance on how to add additional pages, structure your documentation, and accept community contributions, all with the goal of letting you focus on creating great content.”

Google Blog: Introducing Season of Docs

Google Blog: Introducing Season of Docs. “Google Open Source is delighted to announce Season of Docs, a new program which fosters the open source contributions of technical writers. Season of Docs brings technical writers and open source projects together for a few months to work on open source documentation. 2019 is the first time we’re running this exciting new program.”

TechCrunch: Google publishes its documentation style guide for developers

TechCrunch: Google publishes its documentation style guide for developers. “Documentation is often an afterthought — especially for open-source projects. That can make it harder for newcomers to join a project, for example, and sometimes badly written documentation is worse than having no documentation at all. To help developers write better documentation, Google this week opened up its own developer-documentation style guide.”

NARA: National Archives provides special access to records for veterans impacted by Hurricane Harvey

NARA: National Archives provides special access to records for veterans impacted by Hurricane Harvey. “While flooding and damage caused by Hurricane Harvey continues to devastate Houston, Texas and other Gulf Coast communities, the National Personnel Records Center is providing special help to veterans impacted by the storm.”

Stack Overflow Launches Site for Crowdsourced Documentation

Stack Overflow has launched a site for crowdsourced documentation. “The company says the focus of Stack Overflow Documentation will be ongoing beyond definitions and on providing real-world examples. That becomes obvious when you look at how pages are organized. First come the examples and only then info about parameters and syntax, with additional comments at the bottom of the page.”

Microsoft Has a new Site for Its Documentation

Microsoft has launched a new site for the documentation for its services. “Entire articles have been chopped up into smaller ones with buttons for navigating to next and previous sections. The pages are responsive, so they’ll adjust nicely as browser window sizes change, and they’ll look fine on mobile devices. Each page has an area for comments (thanks to a Livefyre integration), Facebook and Twitter sharing buttons, and an Edit button that routes users to the corresponding GitHub page — because, after all, the documentation on all these pages is available under an open source license.”