Most people, if not everyone involved in a software development project, would agree that documentation is an essential part of the process. It’s a fact that developers consider documentation to be an essential tool to understand and get started using a software product. Technical documentation remains a top online resource for developers learning to code, according to the latest Stack Overflow Developer Survey. 2023 Stack Overflow Developer Survey Results However, it is also one of the most overlooked aspects of the software development life cycle.
Technical Documentation and Agile Very often, when I join a new team and I ask if there’s any existing documentation, the answer tends to be: “No, we don’t have docs.” And most of the time this is not true. Agile teams that don’t have a technical writer assigned tend to think that they don’t have any documentation or very little documentation in place. But the reality is that they have many information lying around in Pull Requests or Jira tickets; or even commit messages.
I have a Raspberry Pi 4, but every time I wanted to use it I needed to plug in the external monitor, keyboard, and mouse… It’s not a lot of work, but sometimes I wished there was a simpler way to start using it quickly. Recently, I found out a practical way to do it. I already have an Apple setup, and I was thinking of ways I could use my existing setup seamlessly with my Raspberry Pi.
Why Adding Google Analytics? Measuring the impact of your documentation is an important part of evaluating your documentation efforts. And one of the most useful metrics to take into account to measure documentation impact is the user engagement. Google Analytics is one of the most popular and easy to use tools to implement and track websites traffic. And it’s fairly easy to implement into a static site, such as a Jekyll blog or documentation site.
This tutorial explains how to create a documentation site with automatic deployments and syntax linting. Tools The tools you need are all free to use and are the following: Hugo A Static Site Generator. Azure Static Web Apps Static web sites hosting service (Free for personal use, see Pricing). Vale Grammar and syntax linter. GitHub Repository hosting. GitHub Actions GitHub feature for automation pipelines. Creating the Static Site To create a new Hugo site:
Working with documentation today most likely involves treating docs as code. To follow the docs as code approach you need to know the tools required to create documentation using plain text and markup languages, putting your docs in an online repository, and generating static files to create your documentation site. The following is a list of the most common tools to treat docs like code: Markup Languages Markup languages enable you to write text in a human readable form but using a specific syntax that can be processed by tools, such as a static site generator in this case.
About the Raspberry Pi The Raspberry Pi is a small, powerful, low-cost, single-board computer. It is available in different models and presentations; you can get the board only or buy a kit including case, keyboard, mouse, power supply, etc. It is also available as a computer built into a small keyboard. The Raspberry Pi 4 is available in three different versions: 2GB, 4GB, and 8GB. Raspberry Pi 4 components As you can see, the Raspberry Pi comes with everything you need to set up a fully functional computer.
What Are Static Sites? Static sites are commonly described as web pages with fixed content, or content that remains the same for all visitors of the web pages. While this is mostly true, some discrepancies can exist depending on some cases. As stated before, static web sites usually consisted of pages with static content created using HTML and CSS. They were requested by the client and delivered as they were stored by the web server via HTTP to be displayed by a web browser.
What is AWS Route 53? AWS Route 53 is a Domain Name System (DNS) service. It allows you to purchase, register, and route end users to your web applications or static web pages (S3 hosted pages). Route 53 translates the registered custom domain name to the IP address or resources running on AWS, such as EC2 instances, elastic load balancers, or S3 buckets. In this post you can see how to register a custom domain name and use it to route end users to a static web page hosted on Amazon S3.
Here’s how you can implement it in your organization or project The NYTimes Library App If you work with documentation, you know it is hard to maintain it. The NYTimes faced this issue, so they created a collaborative documentation site that renders content from existing Google Docs. The best part is that they decided to make it open source, so I decided to give it a try. The easiest way to implement it is using Heroku, and that was my first approach.