Bit Rot in the Docs

•

8 likes•2,355 views

The document discusses various causes of "bit rot" or technical documentation becoming outdated or inaccurate over time, such as changes to software or documentation platforms. It provides examples of remedies for bit rot like automated testing of code samples in documentation, conducting documentation reviews as part of the engineering process, collaborative testing sessions, and utilizing customer feedback. Remedies are recapped as automated testing, documentation reviews, spot-testing, and customer feedback.

Software

Bit rot
in the docs
#docbitrot @sarahmaddox Bit rot in the docs

bit rot: n.
Hypothetical disease
the existence of which
has been deduced
from the observation
that... Source: The Jargon File
http://goo.gl/YTFTF4
#docbitrot @sarahmaddox Bit rot in the docs

unused programs or
features will often
stop working after
sufficient time has
passed, even if
‘nothing has changed’. Source: The Jargon File
http://goo.gl/YTFTF4
#docbitrot @sarahmaddox Bit rot in the docs

Caused by
cosmic rays?
A notion long favored
by hackers.
#docbitrot @sarahmaddox Bit rot in the docs

Rooting out doc bit rot
#docbitrot @sarahmaddox Bit rot in the docs
Types
Causes
Remedies

Something’s rotten in the state of dem docs
#docbitrot @sarahmaddox Bit rot in the docs
Broken links
Broken inclusions
Outdated information
Fiction
Too much information

“...we found things in the docs that are no longer true,
because we may have subtly changed the
implementation without notifying the tech writers”
#docbitrot @sarahmaddox Bit rot in the docs
More about blitz tests:
http://goo.gl/LnSXkV

Cosmic rays plus...
Changes in environment
Updates to documentation platform
Last-minute changes in software
Human error
#docbitrot @sarahmaddox Bit rot in the docs

Tinfoil hats plus...
Automated testing of code samples
Doc reviews in eng team procedures
Spot-testing
Customer feedback
#docbitrot @sarahmaddox Bit rot in the docs

Automated testing of code samples
Example: Simple Map http://goo.gl/ouVVfk
Automated build system
Real-time excerpts
Benefits:
● Detect breakages in our samples
● Detect breaking changes in the API
● Be proactive with documentation updates
#docbitrot @sarahmaddox Bit rot in the docs

Automated testing of code samples
Example: Simple Map http://goo.gl/ouVVfk
Automated build system
Real-time excerpts
Share tools
Benefits:
● Detect breakages in our samples
● Detect breaking changes in the API
● Be proactive with documentation updates
#docbitrot @sarahmaddox Bit rot in the docs

Doc reviews in eng team procedures
Definition of done http://goo.gl/dT5zF1
Share the same issue tracker
Share the same review tool
Take part in code reviews
#docbitrot @sarahmaddox Bit rot in the docs

Collaborative spot testing
A coordinated testing session
Interested parties testing specific functionality
Testing code and documentation together
Works well for:
● Major update
● Change affecting many API methods
● Feature worked on by more than one engineer
● Work spread over a long period
#docbitrot @sarahmaddox Bit rot in the docs

Collaborative spot testing
#docbitrot @sarahmaddox Bit rot in the docs

Customer feedback
#docbitrot @sarahmaddox Bit rot in the docs
Harnessing the audience
● Feedback on the documentation
● Comments on blog posts
● Twitter
● Google+
● Stack Overflow
● User forums

#docbitrot @sarahmaddox Bit rot in the docs
Doc comments
Doc addition/correction
Support request
Help request
Product feature/improvement
Praise
Other

#docbitrot @sarahmaddox Bit rot in the docs
Feedback Tools
External
● Disqus
● Wufoo
● Qualaroo
Integrated
○ Confluence
○ MindTouch

Recap of bit rot remedies
Automated testing of code samples
Doc reviews in eng team procedures
Spot-testing
Customer feedback
#docbitrot @sarahmaddox Bit rot in the docs

Twitter @sarahmaddox
Google+ +sarahmaddox
Email sarahmaddox@google.com
Slideshare sarahmaddox
Blog ffeathers.wordpress.com
#docbitrot @sarahmaddox Bit rot in the docs
Contacting me

Our industry has a problem: We are not lacking software methodologies, programming languages, tools or frameworks but we need great software engineers. Great software engineer teams build quality-in and deliver great software on a regular basis. The technical excellence of those engineers will help you escape the "Waterfall sandwich" and make your organization a little more agile, from the inception of an idea till they go live. I will talk about my experiences from the last 15 years, including small software delivery teams until big financial institutions. Why would a company like to be "agile"? How can a company achieve that? How can you achieve Technical Excellence in your software teams? What developer skills are more important than languages, methods or frameworks? This will be an interactive session with a Q&A at the end.

Infrastructure is development

stahnma

Plugged-In Management Workshop

Terri Griffith

Accessibility Testing Tools for Developers - Seattle Code Camp

gerardkcohen

You don't have to be an accessibility expert to make your projects accessible, but you do have to make your projects accessible. Identifying accessibility issues as early as possible can save an organization or project a substantial amount of money, time, and headaches over trying to augment a web site or application after initial development. Using a testing tools during development for accessibility will definitely help with this process. For developers that are novice to web accessibility this presentation is a great introduction into key aspects to consider while developing. For developers that are more familiar, this presentation exposes tools that will make accessibility easier. All users will gain from learning how to build accessibility into their development workflow using a variety of testing tools, from simple to intricate. Code is available at https://github.com/gerardkcohen/nightwatch-a11y-testing

Scrum myth buster

Malang QA Community

Alexander Janssens & Gert-Jan van Rooij- Getting started with API

TOPdesk

Do you find yourself with limited influence over what gets shipped on products you test? Is your report card on product quality often ignored? Do you think you can contribute more? Join Gerard Meszaros as he describes ways to transition from approaching quality with brute force testing to an enlightened and strategic perspective that will have real impact on product quality. Instead of criticizing the product, become an integral part of the development process and learn how you can help define what should be built. Gerard explores design for testability concepts and describes key testability requirements that will afford better, more efficient testing. He explains test design techniques that describe software functionality in layers of plain language tests. Gerard shows how a collaborative approach for building the right product results in much better outcomes from both quality and schedule perspectives. Stop rushing through multiple test-and-fix cycles that result in a less than quality product. Be part of the solution!

Atlassian User Group NYC April 27 2017 Presentations

Marlon Palha

Silicon Valley Product Management Association Workshop

Terri Griffith

Test Driven Development on Android (Kotlin Kenya)

Danny Preussler

End-to-end performance testing, profiling, and analysis at Redis

Filipe Oliveira

High-performance (as measured by sub-millisecond response time for queries) is a key characteristic of the Redis database, and it is one of the main reasons why Redis is the most popular key-value database in the world. To continue improving performance across all of the different Redis components, we've developed a framework for automatically triggering performance tests, telemetry gathering, profiling, and data visualization upon code commit. In this short presentation, we describe how this type of automation and "zero-touch" profiling scaled our ability to pursue performance regressions and to find opportunities to improve the efficiency of our code, helping us (as a company) to start shifting from a reactive to a more proactive performance mindset.

Enabling Microservices @Orbitz - DevOpsDays Chicago 2015

Steve Hoffman

Atlassian User Group NYC 03302017 Presentations

Marlon Palha

Technical Excellence - OOP Munich 2015

James Grenning

TechSEO Boost 2018: Programming Basics for SEOs

Catalyst

Learn to code! You’ve heard it before, but starting seems like a monumental undertaking. It’s not. And, even a basic understanding of programming can pay off immensely. You’d be surprised by how much more efficiently and effectively you can work with your developer counterparts once you have a few easy concepts down. In this session, Catalyst’s Paul Shapiro will help get you started. Paul will discuss the fundamental components that make up a computer program and how you can easily leverage them to improve your work as an SEO. You’ll learn about basic concepts like loops, variables, if-else statements, functions, and arrays (they sound scarier than they are!), how to identify specific marketing tasks you do today that can benefit from basic programming skills and knowledge, how to pick your first programming language, and more.

ESADE - Plugged-In Management

Terri Griffith

Accessibility Testing Tools for Developers - Gerard K. Cohen - CSUN 2016

gerardkcohen

There're a lot of accessibility tools available today. This presentation will provide an overview of these tools, and how they can be built into your workflow. From basic, all the way to advanced automated E2E testing. Geared for front-end developers/ engineers looking to improve the accessibility of their work. Working code examples are available at https://github.com/gerardkcohen/nightwatch-a11y-testing

Let Codenarc check if you write good Groovy code

Alberto De Ávila Hernández

So we're going no-QA - how do we get the devs to do enough testing?

Steve Wells

Tear Up Your Roadmap and Get Out of the Building

Atlassian

You’d never knowingly ship something to your customers that didn’t deliver value, would you? Would you still stand your ground if you were under pressure to get a team of developers working on something? You probably know that one of Atlassian’s most well-known values is “Don’t f*** the customer”, so learn what happened when a lean product team decided to tear up the roadmap because they were brave enough to admit they didn’t understand their customers well enough. Join Janel Blattler, as she shares how her team used research to unveil a new plan in just a few weeks. You’ll be able to practice some techniques and walk away with a bucket load of inspiration. Come along if you’d like to run research, but worry that you don’t have enough time or lack the skills to do so – you don’t need to be a researcher on your team. This session is for you if you’re looking for ways to drive customer empathy closer in the team, or you’d like to up your game and discover some new techniques for delivering lean research with actionable insights.

Test your own stuff agile testing days usa 2018

Alex Kell

DevOps and Continuous Delivery Reference Architectures (including Nexus and o...

Sonatype

Nitro for your Grails App: How to improve performance!! Greach' 18

Alberto Barón Cuevas

Staying Ahead of the Curve

Trisha Gee

Django best practicesAdam Haney

Making operations visible - devopsdays tokyo 2013Nick Galbreath

The future *is* technical communication

Sarah Maddox

Aulas de Cavaquinho. Banjo & Violão Via Internet 2014 (Aprenda s/ sair de sua...

Aulas Via Net Adilson do Cavaco

Ofereço uma Amostra grátis de aula (20 a 40 minutos) p/ o conhecimento do meu método de ensino que é único . È NESCESSÁRIO PORÉM : 1-velocidade suficiente de conexão internet, mínimo de 2000kbps 2- O programa Skype instalado no PC 3- Um microfone simples Maiores Informações: FONES: (19) 3478-3261 ou (019) 99336-7984 Visite o meus sites e confira http://www.adilsondocavacoaulasvianet.com/ http://adilsondocavacoaulas.wix.com/adilsondocavacoaulas2011 https://www.facebook.com/aulas.online.96

What's hot

Build the Right Product Right: Transitioning Test from Critiquing to Defining

TechWell

Atlassian User Group NYC April 27 2017 Presentations

Marlon Palha

Silicon Valley Product Management Association Workshop

Terri Griffith

Test Driven Development on Android (Kotlin Kenya)

Danny Preussler

End-to-end performance testing, profiling, and analysis at Redis

Filipe Oliveira

Enabling Microservices @Orbitz - DevOpsDays Chicago 2015

Steve Hoffman

Atlassian User Group NYC 03302017 Presentations

Marlon Palha

Technical Excellence - OOP Munich 2015

James Grenning

TechSEO Boost 2018: Programming Basics for SEOs

Catalyst

ESADE - Plugged-In Management

Terri Griffith

Accessibility Testing Tools for Developers - Gerard K. Cohen - CSUN 2016

gerardkcohen

Let Codenarc check if you write good Groovy code

Alberto De Ávila Hernández

So we're going no-QA - how do we get the devs to do enough testing?

Steve Wells

Tear Up Your Roadmap and Get Out of the Building

Atlassian

Test your own stuff agile testing days usa 2018

Alex Kell

DevOps and Continuous Delivery Reference Architectures (including Nexus and o...

Sonatype

Nitro for your Grails App: How to improve performance!! Greach' 18

Alberto Barón Cuevas

Staying Ahead of the Curve

Trisha Gee

Django best practicesAdam Haney

Making operations visible - devopsdays tokyo 2013Nick Galbreath

What's hot (20)

Build the Right Product Right: Transitioning Test from Critiquing to Defining

Atlassian User Group NYC April 27 2017 Presentations

Silicon Valley Product Management Association Workshop

Test Driven Development on Android (Kotlin Kenya)

End-to-end performance testing, profiling, and analysis at Redis

Enabling Microservices @Orbitz - DevOpsDays Chicago 2015

Atlassian User Group NYC 03302017 Presentations

Technical Excellence - OOP Munich 2015

TechSEO Boost 2018: Programming Basics for SEOs

ESADE - Plugged-In Management

Accessibility Testing Tools for Developers - Gerard K. Cohen - CSUN 2016

Let Codenarc check if you write good Groovy code

So we're going no-QA - how do we get the devs to do enough testing?

Tear Up Your Roadmap and Get Out of the Building

Test your own stuff agile testing days usa 2018

DevOps and Continuous Delivery Reference Architectures (including Nexus and o...

Nitro for your Grails App: How to improve performance!! Greach' 18

Staying Ahead of the Curve

Django best practices

Making operations visible - devopsdays tokyo 2013

Viewers also liked

The future *is* technical communication

Sarah Maddox

Aulas de Cavaquinho. Banjo & Violão Via Internet 2014 (Aprenda s/ sair de sua...

Aulas Via Net Adilson do Cavaco

"5 Inspiring Reasons to Manage Projects on SharePoint 2013" SPSRED13

Gina Montgomery, V-TSP

Habitat & Amazon's ECS

Matt Ray

$Slide 06 - As noções de erro e fracasso no contexto escolar: algumas consider...$ $Slide 06 - As noções de erro e fracasso no contexto escolar: algumas consider...$

Slide 06 - As noções de erro e fracasso no contexto escolar: algumas consider...

rafaelly04

Slide 05 - Ranieri e Diogo

rafaelly04

Slide 02 - Thamires e Rafaelly

rafaelly04

Misiones y visiones

Juan Robalino Ortiz

Crime and the poverty penalty in urban Ghana - draft 7 4 16Mayssam Zaaroura

Ipsos MORI Post EU Referendum Consumer Confidence Survey

Ipsos UK

One in ten UK consumers have opted to delay or abandon a big spending decision because of the EU referendum result, a survey by Ipsos MORI for the Telegraph has found. However, the majority (57%) expect their personal financial situation will be unchanged over the next six months. The research, among more than 1,000 UK adults aged between 16 and 75, finds just over a quarter (26%) had been planning a big spending commitment, such as a holiday, car or house move for the coming six months. Of those, 16% have decided to go ahead with the purchase as planned, but 5% have decided to delay and another 5% have decided not to continue at all.

The Tinman Referendum: The EU debate is lacking heart in Scotland

Ipsos UK

La revolución agrícola y el proceso urbano en la sociedad andina

Gusstock Concha Flores

La sociedad andina desde que ocupo suelo americano y peruano, ha sido protagonista de un peculiar proceso de "urbanización", y que debido a la complejidad de su estructura cultural, hoy llama la atención de propios y extraños. La realización de trabajos de investigación con enfoques mixtos y transdisciplinarios, espero, que sean los que permitan decodificar estos fenómenos espacio físico cultural.

Principle of speech delivery

Caitlin Deleon

Fine structure of gene

Sayali28

Sustaining Competitiveness in a Digital Age: How Trust Can Make or Break The ...

accenture

Comparacion de 4 metodos diseño de mezclas

Jonatan German Choquechambi Mamani

Diseño de mezclas de concreto (ACI)

Mauricio Javier Leon Tejada

50 Essential Content Marketing Hacks (Content Marketing World)

Heinz Marketing Inc

Social Media Best Practices, Part 1

David King

Sanitary and water supply

School Of Planning and Architecture, JNA&FAUniversity

Viewers also liked (20)

The future *is* technical communication

Aulas de Cavaquinho. Banjo & Violão Via Internet 2014 (Aprenda s/ sair de sua...

"5 Inspiring Reasons to Manage Projects on SharePoint 2013" SPSRED13

Habitat & Amazon's ECS

$Slide 06 - As noções de erro e fracasso no contexto escolar: algumas consider...$ $Slide 06 - As noções de erro e fracasso no contexto escolar: algumas consider...$

Slide 06 - As noções de erro e fracasso no contexto escolar: algumas consider...

Slide 05 - Ranieri e Diogo

Slide 02 - Thamires e Rafaelly

Misiones y visiones

Crime and the poverty penalty in urban Ghana - draft 7 4 16

Ipsos MORI Post EU Referendum Consumer Confidence Survey

The Tinman Referendum: The EU debate is lacking heart in Scotland

La revolución agrícola y el proceso urbano en la sociedad andina

Principle of speech delivery

Fine structure of gene

Sustaining Competitiveness in a Digital Age: How Trust Can Make or Break The ...

Comparacion de 4 metodos diseño de mezclas

Diseño de mezclas de concreto (ACI)

50 Essential Content Marketing Hacks (Content Marketing World)

Social Media Best Practices, Part 1

Sanitary and water supply

Similar to Bit Rot in the Docs

Cloud Apps - Running Fully Distributed on Mobile Devices - Dominik Rüttimann

distributed matters

The move towards the cloud and towards low powered mobile devices has led to a decline of rich clients, i.e. most apps today are heavily dependent on their home server and thus a stable Internet connection. There are some approaches for local caching of data, however the concrete synchronization mechanism is often intransparent or difficult to control for users. Developers usually need to use different data structures on mobile devices and their cloud servers, thus leading to a multiplication of the code base involved. Meanwhile mobile chip architectures have caught up in performance such that the heavy reliance on the server has become more and more questionable. As an answer to this discrepancy, the Cloud Innovation Team of ATEGRA AG has been developing a fully distributed PaaS called Protogrid. It is based on CouchDB Servers located in the cloud, on premise and even running directly on mobile devices. The Protogrid development environment supports Rapid Application Development, such that a workflow application can be created and deployed offhandedly in a few minutes. Since all client logic is completely independent of the database schema, adaption to new requirements during operation is no issue. All Protogrid Apps can be deployed on various platforms without any additional effort and they are usable offline with no loss of functionality. In particular, this talk will cover experiences and earned knowledge during the implementation of Couchbase Lite and CouchDB replication on mobile clients as well as our innovative approach regarding the database schema in a NoSQL context.

API Documentation Workshop tcworld India 2015

Tom Johnson

Inextricably linked: reproducibility and productivity in data science and AI

Luke Marsden

In this talk Luke presents his team’s research comparing the evolution of Software Development & DevOps with that of Data Science & AI. Because it is more complex and has far more moving parts, Data Science & AI is where Software Development was in 1999: people are emailing and Slacking notebooks to each other, due to a lack of appropriate tooling. There are few CI/CD pipelines and model health monitoring is scarce. A lot that could be automated is still manual. And teams are siloed. This causes problems both for productivity: it’s hard to collaborate, and reproducibility: which impacts on governance and compliance. Luke presents a proposal for an architecture and a set of open source tools to solve both the collaboration and the governance problem in Data Science & AI. With live demos!

Hyperleger Fabric Workshop - Denver Blockchain Week

Horea Porutiu

This slide deck goes into detail about the main concepts in Hyperledger Fabric - peers, orderer, certificate authority, and channels. We talk about chaincode, and go into details about modeling a network which involves putting cars on an auction. I end with a demo of the IBM Blockchain Platform, and give you links to get a free 1-month trial of the Starter Plan Blockchain service on the IBM Blockchain Platform.

Supercharging project health check

David Horvath

[drupalday2017] - Behat per Drupal: test automatici e molto di più

DrupalDay

Behat è nato per semplificare il processo di accettazione da parte del cliente: per evitare ambiguità si realizza un test automatico (leggibile anche da chi non ha competenze tecniche) la cui esecuzione con successo garantisce che le specifiche siano rispettate. L'integrazione di Behat nel processo di sviluppo Drupal permette tuttavia di andare ben oltre: si può usare Behat per condividere le specifiche con il cliente, per guidare lo sviluppo (scrivendo il test prima del codice), per assistere il debug (usando uno scenario per popolare una situazione di errore ripetibile) e persino per migrare un sito da Drupal 7 a Drupal 8 (codificando il comportamento del sito in una serie di test che vengono poi usati come base per lo sviluppo del nuovo sito). Per tutti gli scenari descritti vedremo esempi basati sull'esperienza di Nuvole. di Andrea Pescetti

Web components - The Future is Here

Gil Fink

Techfest design patterns

RookieOne

Design meets presentation November 2013

laurawesley

Everyone wants (someone else) to do it: writing documentation for open source...

Jody Garnett

Docs as-code-missing.-manual

Margaret Eker

Jennifer Rondeau and Margaret Eker presentation from Write The Docs Prague, 2016: Treating docs as code, an approach that more and more teams and companies are moving toward, involves more than putting the two together in a source repository. We discuss some of the details that often get lost in as dev and docs learn to work together in new ways. Because if all we do is put doc files next to code files in source control, or use parts of the same workflow for code and docs, we're still isolating docs as a separate sort of responsibility, free from the obligations of systematic review and testing without which code would never be accepted into production.

Basics of Open Source Contribution - WWCodeMobile

Vui Nguyen

Crowd Documentation - How Programmer Social Communities are Flipping Software...

Chris Parnin

O'Leary - Using GitHub for Enterprise and Open Source Documentation

LavaCon

WSO2CON 2024 - Software Engineering for Digital Businesses

WSO2

Landing code in curl

Daniel Stenberg

Publishing strategies for API documentation

Tom Johnson

Most of the common tools for publishing help material fall short when it comes to API documentation. Much API documentation (such as for Java, C++, or .NET APIs) is generated from comments in the source code. Their outputs don’t usually integrate with other help material, such as programming tutorials or scenario-based code samples. REST APIs are a breed of their own, with almost no standard tools for generating documentation from the source. The variety of outputs for REST APIs are as diverse as the APIs themselves, as you can see by browsing the 11,000+ web APIs on programmableweb.com. As a technical writer, what publishing strategies do you use for API documentation? Do you leave the reference material separate from the tutorials and code samples? Do you convert everything to DITA and merge it into a single output? Do you build your own help system from scratch that imports your REST API information? There’s not a one-size-fits-all approach. In this presentation, you’ll learn a variety of publishing strategies for different kinds of APIs, with examples of what works well for developer audiences. No matter what kind of API you’re working with, you’ll benefit from this survey of the API doc publishing scene. - See more at: http://idratherbewriting.com

George Bina: DITA for Developers and GitHub for Technical Writers

Jack Molisani

Hexagonal Symfony - SymfonyCon Amsterdam 2019

Matthias Noback

There is something about serverless

gjdevos

Similar to Bit Rot in the Docs (20)

Cloud Apps - Running Fully Distributed on Mobile Devices - Dominik Rüttimann

API Documentation Workshop tcworld India 2015

Inextricably linked: reproducibility and productivity in data science and AI

Hyperleger Fabric Workshop - Denver Blockchain Week

Supercharging project health check

[drupalday2017] - Behat per Drupal: test automatici e molto di più

Web components - The Future is Here

Techfest design patterns

Design meets presentation November 2013

Everyone wants (someone else) to do it: writing documentation for open source...

Docs as-code-missing.-manual

Basics of Open Source Contribution - WWCodeMobile

Crowd Documentation - How Programmer Social Communities are Flipping Software...

O'Leary - Using GitHub for Enterprise and Open Source Documentation

WSO2CON 2024 - Software Engineering for Digital Businesses

Landing code in curl

Publishing strategies for API documentation

George Bina: DITA for Developers and GitHub for Technical Writers

Hexagonal Symfony - SymfonyCon Amsterdam 2019

There is something about serverless

Recently uploaded

Graspan: A Big Data System for Big Code Analysis

Aftab Hussain

We built a disk-based parallel graph system, Graspan, that uses a novel edge-pair centric computation model to compute dynamic transitive closures on very large program graphs. We implement context-sensitive pointer/alias and dataflow analyses on Graspan. An evaluation of these analyses on large codebases such as Linux shows that their Graspan implementations scale to millions of lines of code and are much simpler than their original implementations. These analyses were used to augment the existing checkers; these augmented checkers found 132 new NULL pointer bugs and 1308 unnecessary NULL tests in Linux 4.4.0-rc5, PostgreSQL 8.3.9, and Apache httpd 2.2.18. - Accepted in ASPLOS ‘17, Xi’an, China. - Featured in the tutorial, Systemized Program Analyses: A Big Data Perspective on Static Analysis Scalability, ASPLOS ‘17. - Invited for presentation at SoCal PLS ‘16. - Invited for poster presentation at PLDI SRC ‘16.

Why Mobile App Regression Testing is Critical for Sustained Success_ A Detail...

kalichargn70th171

A dynamic process unfolds in the intricate realm of software development, dedicated to crafting and sustaining products that effortlessly address user needs. Amidst vital stages like market analysis and requirement assessments, the heart of software development lies in the meticulous creation and upkeep of source code. Code alterations are inherent, challenging code quality, particularly under stringent deadlines.

Custom Healthcare Software for Managing Chronic Conditions and Remote Patient...

Mind IT Systems

OpenMetadata Community Meeting - 5th June 2024

OpenMetadata

The OpenMetadata Community Meeting was held on June 5th, 2024. In this meeting, we discussed about the data quality capabilities that are integrated with the Incident Manager, providing a complete solution to handle your data observability needs. Watch the end-to-end demo of the data quality features. * How to run your own data quality framework * What is the performance impact of running data quality frameworks * How to run the test cases in your own ETL pipelines * How the Incident Manager is integrated * Get notified with alerts when test cases fail Watch the meeting recording here - https://www.youtube.com/watch?v=UbNOje0kf6E

A Study of Variable-Role-based Feature Enrichment in Neural Models of Code

Aftab Hussain

Understanding variable roles in code has been found to be helpful by students in learning programming -- could variable roles help deep neural models in performing coding tasks? We do an exploratory study. - These are slides of the talk given at InteNSE'23: The 1st International Workshop on Interpretability and Robustness in Neural Software Engineering, co-located with the 45th International Conference on Software Engineering, ICSE 2023, Melbourne Australia

Enterprise Resource Planning System in Telangana

NYGGS Automation Suite

Enterprise Resource Planning System includes various modules that reduce any business's workload. Additionally, it organizes the workflows, which drives towards enhancing productivity. Here are a detailed explanation of the ERP modules. Going through the points will help you understand how the software is changing the work dynamics. To know more details here: https://blogs.nyggs.com/nyggs/enterprise-resource-planning-erp-system-modules/

Utilocate provides Smarter, Better, Faster, Safer Locate Ticket Management

Utilocate

Utilocate offers a comprehensive solution for locate ticket management by automating and streamlining the entire process. By integrating with Geospatial Information Systems (GIS), it provides accurate mapping and visualization of utility locations, enhancing decision-making and reducing the risk of errors. The system's advanced data analytics tools help identify trends, predict potential issues, and optimize resource allocation, making the locate ticket management process smarter and more efficient. Additionally, automated ticket management ensures consistency and reduces human error, while real-time notifications keep all relevant personnel informed and ready to respond promptly. The system's ability to streamline workflows and automate ticket routing significantly reduces the time taken to process each ticket, making the process faster and more efficient. Mobile access allows field technicians to update ticket information on the go, ensuring that the latest information is always available and accelerating the locate process. Overall, Utilocate not only enhances the efficiency and accuracy of locate ticket management but also improves safety by minimizing the risk of utility damage through precise and timely locates.

May Marketo Masterclass, London MUG May 22 2024.pdf

Adele Miller

openEuler Case Study - The Journey to Supply Chain Security

Shane Coughlan

GOING AOT WITH GRAALVM FOR SPRING BOOT (SPRING IO)

Alina Yurenko

2024 eCommerceDays Toulouse - Sylius 2.0.pdf

Łukasz Chruściel

Using Xen Hypervisor for Functional Safety

Ayan Halder

GraphSummit Paris - The art of the possible with Graph Technology

Neo4j

Transform Your Communication with Cloud-Based IVR Solutions

TheSMSPoint

Discover the power of Cloud-Based IVR Solutions to streamline communication processes. Embrace scalability and cost-efficiency while enhancing customer experiences with features like automated call routing and voice recognition. Accessible from anywhere, these solutions integrate seamlessly with existing systems, providing real-time analytics for continuous improvement. Revolutionize your communication strategy today with Cloud-Based IVR Solutions. Learn more at: https://thesmspoint.com/channel/cloud-telephony

Launch Your Streaming Platforms in Minutes

Roshan Dwivedi

The claim of launching a streaming platform in minutes might be a bit of an exaggeration, but there are services that can significantly streamline the process. Here's a breakdown: Pros of Speedy Streaming Platform Launch Services: No coding required: These services often use drag-and-drop interfaces or pre-built templates, eliminating the need for programming knowledge. Faster setup: Compared to building from scratch, these platforms can get you up and running much quicker. All-in-one solutions: Many services offer features like content management systems (CMS), video players, and monetization tools, reducing the need for multiple integrations. Things to Consider: Limited customization: These platforms may offer less flexibility in design and functionality compared to custom-built solutions. Scalability: As your audience grows, you might need to upgrade to a more robust platform or encounter limitations with the "quick launch" option. Features: Carefully evaluate which features are included and if they meet your specific needs (e.g., live streaming, subscription options). Examples of Services for Launching Streaming Platforms: Muvi [muvi com] Uscreen [usencreen tv] Alternatives to Consider: Existing Streaming platforms: Platforms like YouTube or Twitch might be suitable for basic streaming needs, though monetization options might be limited. Custom Development: While more time-consuming, custom development offers the most control and flexibility for your platform. Overall, launching a streaming platform in minutes might not be entirely realistic, but these services can significantly speed up the process compared to building from scratch. Carefully consider your needs and budget when choosing the best option for you.

Top Features to Include in Your Winzo Clone App for Business Growth (4).pptx

rickgrimesss22

LORRAINE ANDREI_LEQUIGAN_HOW TO USE ZOOM

lorraineandreiamcidl

Essentials of Automations: The Art of Triggers and Actions in FME

Safe Software

In this second installment of our Essentials of Automations webinar series, we’ll explore the landscape of triggers and actions, guiding you through the nuances of authoring and adapting workspaces for seamless automations. Gain an understanding of the full spectrum of triggers and actions available in FME, empowering you to enhance your workspaces for efficient automation. We’ll kick things off by showcasing the most commonly used event-based triggers, introducing you to various automation workflows like manual triggers, schedules, directory watchers, and more. Plus, see how these elements play out in real scenarios. Whether you’re tweaking your current setup or building from the ground up, this session will arm you with the tools and insights needed to transform your FME usage into a powerhouse of productivity. Join us to discover effective strategies that simplify complex processes, enhancing your productivity and transforming your data management practices with FME. Let’s turn complexity into clarity and make your workspaces work wonders!

E-commerce Application Development Company.pdf

Hornet Dynamics

Cracking the code review at SpringIO 2024

Paco van Beckhoven

Code reviews are vital for ensuring good code quality. They serve as one of our last lines of defense against bugs and subpar code reaching production. Yet, they often turn into annoying tasks riddled with frustration, hostility, unclear feedback and lack of standards. How can we improve this crucial process? In this session we will cover: - The Art of Effective Code Reviews - Streamlining the Review Process - Elevating Reviews with Automated Tools By the end of this presentation, you'll have the knowledge on how to organize and improve your code review proces

Recently uploaded (20)

Graspan: A Big Data System for Big Code Analysis

Why Mobile App Regression Testing is Critical for Sustained Success_ A Detail...

Custom Healthcare Software for Managing Chronic Conditions and Remote Patient...

OpenMetadata Community Meeting - 5th June 2024

A Study of Variable-Role-based Feature Enrichment in Neural Models of Code

Enterprise Resource Planning System in Telangana

Utilocate provides Smarter, Better, Faster, Safer Locate Ticket Management

May Marketo Masterclass, London MUG May 22 2024.pdf

openEuler Case Study - The Journey to Supply Chain Security

GOING AOT WITH GRAALVM FOR SPRING BOOT (SPRING IO)

2024 eCommerceDays Toulouse - Sylius 2.0.pdf

Using Xen Hypervisor for Functional Safety

GraphSummit Paris - The art of the possible with Graph Technology

Transform Your Communication with Cloud-Based IVR Solutions

Launch Your Streaming Platforms in Minutes

Top Features to Include in Your Winzo Clone App for Business Growth (4).pptx

LORRAINE ANDREI_LEQUIGAN_HOW TO USE ZOOM

Essentials of Automations: The Art of Triggers and Actions in FME

E-commerce Application Development Company.pdf

Cracking the code review at SpringIO 2024

Bit Rot in the Docs

1. Bit rot in the docs #docbitrot @sarahmaddox Bit rot in the docs

2. bit rot: n. Hypothetical disease the existence of which has been deduced from the observation that... Source: The Jargon File http://goo.gl/YTFTF4 #docbitrot @sarahmaddox Bit rot in the docs

3. unused programs or features will often stop working after sufficient time has passed, even if ‘nothing has changed’. Source: The Jargon File http://goo.gl/YTFTF4 #docbitrot @sarahmaddox Bit rot in the docs

4. Caused by cosmic rays? A notion long favored by hackers. #docbitrot @sarahmaddox Bit rot in the docs

5. Rooting out doc bit rot #docbitrot @sarahmaddox Bit rot in the docs Types Causes Remedies

6. Something’s rotten in the state of dem docs #docbitrot @sarahmaddox Bit rot in the docs Broken links Broken inclusions Outdated information Fiction Too much information

7. “...we found things in the docs that are no longer true, because we may have subtly changed the implementation without notifying the tech writers” #docbitrot @sarahmaddox Bit rot in the docs More about blitz tests: http://goo.gl/LnSXkV

8. Cosmic rays plus... Changes in environment Updates to documentation platform Last-minute changes in software Human error #docbitrot @sarahmaddox Bit rot in the docs

9. Cosmic rays plus... Changes in environment Updates to documentation platform Last-minute changes in software Human error #docbitrot @sarahmaddox Bit rot in the docs

10. Tinfoil hats plus... Automated testing of code samples Doc reviews in eng team procedures Spot-testing Customer feedback #docbitrot @sarahmaddox Bit rot in the docs

11. Automated testing of code samples Example: Simple Map http://goo.gl/ouVVfk Automated build system Real-time excerpts Benefits: ● Detect breakages in our samples ● Detect breaking changes in the API ● Be proactive with documentation updates #docbitrot @sarahmaddox Bit rot in the docs

12. Automated testing of code samples Example: Simple Map http://goo.gl/ouVVfk Automated build system Real-time excerpts Share tools Benefits: ● Detect breakages in our samples ● Detect breaking changes in the API ● Be proactive with documentation updates #docbitrot @sarahmaddox Bit rot in the docs

13. Doc reviews in eng team procedures Definition of done http://goo.gl/dT5zF1 Share the same issue tracker Share the same review tool Take part in code reviews #docbitrot @sarahmaddox Bit rot in the docs

14. Collaborative spot testing A coordinated testing session Interested parties testing specific functionality Testing code and documentation together Works well for: ● Major update ● Change affecting many API methods ● Feature worked on by more than one engineer ● Work spread over a long period #docbitrot @sarahmaddox Bit rot in the docs

15. Collaborative spot testing #docbitrot @sarahmaddox Bit rot in the docs

16. Customer feedback #docbitrot @sarahmaddox Bit rot in the docs Harnessing the audience ● Feedback on the documentation ● Comments on blog posts ● Twitter ● Google+ ● Stack Overflow ● User forums

17. #docbitrot @sarahmaddox Bit rot in the docs Doc comments Doc addition/correction Support request Help request Product feature/improvement Praise Other

18. #docbitrot @sarahmaddox Bit rot in the docs Feedback Tools External ● Disqus ● Wufoo ● Qualaroo Integrated ○ Confluence ○ MindTouch

19. Recap of bit rot remedies Automated testing of code samples Doc reviews in eng team procedures Spot-testing Customer feedback #docbitrot @sarahmaddox Bit rot in the docs

20. Recap of bit rot remedies Automated testing of code samples Doc reviews in eng team procedures Spot-testing Customer feedback #docbitrot @sarahmaddox Bit rot in the docs Blitz tests (freebie)

21. Twitter @sarahmaddox Google+ +sarahmaddox Email sarahmaddox@google.com Slideshare sarahmaddox Blog ffeathers.wordpress.com #docbitrot @sarahmaddox Bit rot in the docs Contacting me

Bit Rot in the Docs

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (20)

Similar to Bit Rot in the Docs

Similar to Bit Rot in the Docs (20)

More from Sarah Maddox

More from Sarah Maddox (13)

Recently uploaded

Recently uploaded (20)

Bit Rot in the Docs