How Docs as Code can help with quality assurance

Harnessing Version Control for Documentation Version control isn't just for code anymore. By applying it to documentation through the "Docs as Code" approach, teams gain the ability to track every change, collaborate seamlessly, and revert to previous versions when necessary. This ensures documentation evolves alongside the software it describes, providing a reliable and up-to-date resource for users and developers alike. 🔗 Read the full article in our blog: https://buff.ly/4aIkrtu #TechnicalWriting #TechWriting #TechnicalWriter #TechnicalDocumentation #Documentation #Asciidoc #DocsAsCode #adocStudio #Mac #macOS #iPad #iPadOS #Apple

Reusing Documentation Components for Efficiency In the "Docs as Code" methodology, reusability is key. By treating documentation components like code snippets, teams can reuse them across different projects or documents. This not only saves time but also ensures consistency and reliability in the documentation provided to users. 🔗 Read the full article in our blog: https://buff.ly/4aIkrtu #TechnicalWriting #TechWriting #TechnicalWriter #TechnicalDocumentation #Documentation #Asciidoc #DocsAsCode #adocStudio #Mac #macOS #iPad #iPadOS #Apple

Hello, I wrote part 2 of my Embedded Software Testing series, with practical examples you can try it out. Next installment I'll write about test scheduling strategies. https://lnkd.in/dVgvp7ps

Straight to the Point: Brevity in Technical Documents" Brevity means delivering information in a concise manner, without unnecessary details. For instance, if a document is explaining how to install software, it should not delve into the history of the software's development. It should focus on the installation steps. This approach respects the user's time and keeps their attention on the essential actions they need to take. 🔗 Read the full article in our blog: https://buff.ly/43xn92h #TechnicalWriting #TechWriting #TechnicalWriter #TechnicalDocumentation #Documentation #Asciidoc #DocsAsCode #adocStudio #Mac #macOS #iPad #iPadOS #Apple

Docker for testing embedded systems One trend over the last few year with the clients I've worked with is their adoption of Docker to spin up test environments for test automation against embedded systems. Docker enables several related use cases that all depend on Docker's capability of providing consistent, portable environments. A single Docker image can contain all the necessary dependencies to run a test environment. By hosting an image in a repository you can distribute it to several hosts and be confident they are all running the same environment. The primary use case for this is to make it simpler to provision new test rigs and, over time, ensure they are all maintained to the same version. It also opens up the possibility of developers running the same test environment on their local desk-side test rig as that being run in CI even if a developer is using a Windows-based PC and CI is Linux-based. This is typically known as a dev container. In a similar way, this makes it possible to provide a new team member with a standard development environment during on-boarding. There are a number of challenges to overcome to get this to work well in an embedded systems setting. It requires detailed understanding of low-level Linux and Docker configuration. The most fundamental problem is that you need access to the devices on the host in order to do anything meaningful with the device under test. However, we want to avoid the need to run a container as root, for instance via needing the `--privileged` flag. Instead we can provide the `--device` flag to the docker runtime. Typically this is used alongside the appropriate `udev` rules for each of the USB devices the test environment will need access to. On Windows, Docker is typically hosted via Windows Subsystem for Linux (WSL) which does not allow sharing USB devices with containers so a work-around is needed such as USB/IP. This tunnels the USB protocol over a TCP socket between the host and container. Once these hurdles have been overcome there are some remaining challenges relating to the design and implementation of the Dockerfile such as the choice of suitable base image and the way entry points are setup for each of the required use cases. Typically several Docker images are needed, at least one per use case. Is your organisation considering using Docker in your test automation systems for embedded? If are you, what are your biggest challenges? #Docker #TestAutomation #EmbeddedSystems #SoftwareDevelopment

Point-free just released a new tutorial called „Building SyncUps.” It is all about TCA, Navigation, shared state, testability, and more. Definitely worth checking out alongside Life Progress repository 🙂 Check it out ⬇️ https://lnkd.in/dDHKZV2S Life Progress repository ⬇️ https://lnkd.in/dca4nzeR #TCA #TheComposableArchitecture #iOS #iOSDev #swift #swiftlang #iosdevelopment

If you have just recently run across my random posts, please take a look at one of my most popular past blog posts: "The Matthew Test: 15 Steps to Better Embedded Software (and Firmware)" And send me a note with your team's score! https://lnkd.in/eWDq8AT

Have You Come Across These 5 Must-Have Tests for Robust Embedded Systems? There are more than 100 different types of tests you could perform on your embedded devices. Here's how to develop your own testing strategy. Thanks for sharing Jacob Beningo who is an embedded software consultant. #embedded #software #developer #robustsystems #testing #devices #tntegration #acceptance #cpu

There have been some changes to the WWDC Notes for this year. I nearly missed this update because the old site lacks links to the new one, which is quite unusual! Here is the link if someone also missed it: https://lnkd.in/dUb_Ux2v #wwdc24 #wwdcnotes #ios #iosdoc #iosdeveloper