Write documentation that actually works for your community: Write documentation that actually works for your community olga-merkulova Thu, 03/16/2023 – 03:00 What distinguishes successful and sustainable projects from those that disappeared into the void? Spoiler — it’s community. Community is what drives an open source project, and documentation is one of the foundational blocks for …
Improve your documentation with JavaScript: Improve your documentation with JavaScript Jim Hall Thu, 12/15/2022 – 03:00 Open source software projects often have a very diverse user group. Some users might be very adept at using the system and need very little documentation. For these power users, documentation might only need to be reminders and hints, …
Our favorite markup languages for documentation: Our favorite markup languages for documentation Opensource.com Thu, 12/08/2022 – 03:00 Documentation is important for so many reasons. Readable documentation is even more so. In the world of open source software, documentation is how to use or contribute to an application. It’s like the rulebook for a game. There …
Write documentation like you develop code: Write documentation like you develop code Lorna Mitchell Fri, 10/28/2022 – 03:00 Many engineers and craftspeople are particular about their tools. To do a job well, you need the best tools and the skills to use them. The best tools in software development can be very powerful when applied …
Writing project documentation in HTML: Writing project documentation in HTML Jim Hall Fri, 08/12/2022 – 03:00 Register or Login to like Register or Login to like Documentation is an important part of any technical project. Good documentation tells the end user how to run the program, how to use it, or how to compile it. …
4 levels of DevOps documentation maturity: DevOps and DevSecOps require agile documentation practices to deliver quality documentation on time with an iterative software delivery cycle. It’s a similar journey to DevOps with a move to automation and a more agile approach to content. If documentation is only now entering your organization’s DevOps discussions, it’s time …
A DevOps guide to documentation: DevOps is challenging technical documentation norms like at no other time in IT history. From automation to increased delivery velocity to dismantling the waterfall software development lifecycle model, these all spell the need for making dramatic changes to business and the philosophy of technical documentation. Here are some ways DevOps …
South Africa in the news: Citi Launches Digitized Documentation for Cross-Border Payments: Citi has announced the launch of a new service for its institutional clients that speeds up the processing of their cross-border payments through the digitization of supporting documents. The service, …: “South Africa” – BingNews Merafe loss falls, electricity risk remains, logistics challenge …
3 ways to improve your open hardware documentation: Open Hardware Month is organized by the Open Source Hardware Association (OSHWA) every October, and this year, we’re putting the spotlight on ways to tell the world that your project is open source. Help support the open hardware ecosystem by bolstering your documentation in these three ways …
5 questions to ask yourself when writing project documentation: Before getting down to the actual writing part of documenting another one of your open source projects, and even before interviewing the experts, it’s a good idea to answer some high-level questions about your new document. Renowned communication theorist Harold Lasswell wrote in his 1948 article, …
5 tips for making documentation a priority in open source projects: Open source software is now mainstream; long gone are the days when open source projects attracted developers alone. Nowadays, users across numerous industries are active consumers of open source software, and you can’t expect everyone to know how to use the software just by …
How to create a documentation site with Docsify and GitHub Pages: Documentation is an essential part of making any open source project useful to users. But it’s not always developers’ top priority, as they may be more focused on making their application better than on helping people use it. This is why making it easier …
5 open source tools for email, note taking, and documentation: Most collaborative tools these days recognize that not all users have accounts with their company or suite. In other words, if someone sends you a link to share.example.com but you don’t have an account with example.com, then you’ll likely be offered a chance to sign up. read …
Navigating Ansible documentation, automating patching, virtualization, and more news: In this third edition of Ansible Around The Web, we’ve a delicious spread of ops-related YouTube content, and in the blogs section, guides to virtualization with oVirt and help navigating the extensive Ansible documentation. If you spot an interesting Ansible story on your travels, please send us the link …
Building custom documentation workflows with Sphinx: Sphinx is a popular application for creating documentation, similar to JavaDoc or Jekyll. However, Sphinx’s reStructured Text input allows for a higher degree of customization than those other tools. This tutorial will explain how to customize Sphinx to suit your workflow. You can follow along using sample code on GitHub. …
7 rules for avoiding documentation pitfalls: English serves as lingua franca in the open source community. To reduce translation costs, many teams have switched to English as the source language for their documentation. But surprisingly, writing in English for an international audience does not necessarily put native English speakers in a better position. On the …
How to create better documentation with a kanban board: If you’re working on documentation, a website, or other user-facing content, it’s helpful to know what users expect to find—both the information they want and how the information is organized and structured. After all, great content isn’t very useful if people can’t find what they’re looking …
Why pair writing helps improve documentation: Professional writers, at least in the Red Hat documentation team, nearly always work on docs alone. But have you tried writing as part of a pair? In this article, I’ll explain a few benefits of pair writing. read more: Opensource.com maxim-svistunov Supporting Open Source. Have you tried: Diving with …