Skip to main content

JetBrains launches new tool for creating technical documentation

JetBrains is hoping to improve the way technical documentation is created with a new tool called Writerside.

Currently in an Early Access Program, Writerside is a platform for writing and collaborating on documentation, API references, tutorials, developer guides, and how-tos. It can be used as a plugin in the JetBrains IDE or as a standalone tool.

“With Writerside, we want to empower writers with the tools that developers have long been using. Unfortunately, documentation is still often overlooked, and technical writers don’t get the acknowledgement or the support they deserve”, said Anna Gasparyan, product lead for Writerside at JetBrains. “Our mission is to bridge the gap between developers and writers and make documentation a team sport. If tech writers use the same tools as developers, such as Git, automated check, and build pipelines, it not only ensures the quality of the final output, but it should also make it easier for the entire team to contribute to docs, review them, and track changes.”

It supports Markdown and XML, and comes with over 100 built-in tests. These include testing for broken links, missing resources, incorrect attribute values, non-unique IDs, and more. Developers can also configure it to check for their in-house spelling and style conventions. 

Writeside offers developers a live preview of what their documentation will look like to users. It also includes customization options for look, such as light or dark mode, contrast, soft or vivid skins, and defining accent colors. 

Another key feature to note is that it maintains a single source of truth for projects, enabling developers to reuse portions of content and edit them from just one place rather than having to update every instance when changes are made. 

It uses JetBrains’ spellchecker and grammar tool, which uses AI to make its corrections. Currently this tool supports over 25 languages, include English, German, Spanish, and Chinese. 

The post JetBrains launches new tool for creating technical documentation appeared first on SD Times.



from SD Times https://ift.tt/RLnyi4X
Labels:

Comments

Post a Comment

Popular posts from this blog

Difference between Web Designer and Web Developer Neeraj Mishra The Crazy Programmer

Have you ever wondered about the distinctions between web developers’ and web designers’ duties and obligations? You’re not alone! Many people have trouble distinguishing between these two. Although they collaborate to publish new websites on the internet, web developers and web designers play very different roles. To put these job possibilities into perspective, consider the construction of a house. To create a vision for the house, including the visual components, the space planning and layout, the materials, and the overall appearance and sense of the space, you need an architect. That said, to translate an idea into a building, you need construction professionals to take those architectural drawings and put them into practice. Image Source In a similar vein, web development and design work together to create websites. Let’s examine the major responsibilities and distinctions between web developers and web designers. Let’s get going, shall we? What Does a Web Designer Do?
Post a Comment
Read more

A guide to data integration tools

CData Software is a leader in data access and connectivity solutions. It specializes in the development of data drivers and data access technologies for real-time access to online or on-premise applications, databases and web APIs. The company is focused on bringing data connectivity capabilities natively into tools organizations already use. It also features ETL/ELT solutions, enterprise connectors, and data visualization. Matillion ’s data transformation software empowers customers to extract data from a wide number of sources, load it into their chosen cloud data warehouse (CDW) and transform that data from its siloed source state, into analytics-ready insights – prepared for advanced analytics, machine learning, and artificial intelligence use cases. Only Matillion is purpose-built for Snowflake, Amazon Redshift, Google BigQuery, and Microsoft Azure, enabling businesses to achieve new levels of simplicity, speed, scale, and savings. Trusted by companies of all sizes to meet
Post a Comment
Read more

2022: The year of hybrid work

Remote work was once considered a luxury to many, but in 2020, it became a necessity for a large portion of the workforce, as the scary and unknown COVID-19 virus sickened and even took the lives of so many people around the world.  Some workers were able to thrive in a remote setting, while others felt isolated and struggled to keep up a balance between their work and home lives. Last year saw the availability of life-saving vaccines, so companies were able to start having the conversation about what to do next. Should they keep everyone remote? Should they go back to working in the office full time? Or should they do something in between? Enter hybrid work, which offers a mix of the two. A Fall 2021 study conducted by Google revealed that over 75% of survey respondents expect hybrid work to become a standard practice within their organization within the next three years.  Thus, two years after the world abruptly shifted to widespread adoption of remote work, we are declaring 20
Post a Comment
Read more