How developers write documentation

•Download as PPTX, PDF•

0 likes•329 views

Senthilkumar Gopal

This is a presentation on tooling for documentation using Github and Asciidoc for design and source code documentation

Software

What is Documentation
Material that provides official information or evidence or
that serves as a record.
Written specification and instructions accompanying a
computer program.

Aspects
READABILITY
Available Offline
No custom tools
Standard Templates
EDITOR
Available Offline
No custom tools
Basic In built generators
for TOC, tables etc.,
Reviews
DISTRIBUTION
Versioned
Zero staleness
Close to source of truth

Google Docs
Microsoft Word
Wiki
O365
What’s the point of this
presentation anyway?

GITHUB
Available Offline
No custom tools
Versioned and Reviews
Close to source of truth
Zero staleness
Templates - define your own!
this←

Lingua Franca
MARKDOWN
Released in 2004
Lightweight markup
Plain text formatting
Converted to HTML
Readme files
Online forums
ASCIIDOC
Released in 2002
Equivalent to DocBook
Plain-text mark-up
DocBook tool-chain
PDF, TeX, manpages, e-
books, slides, Git

Choicehttp://counterinception.com/sites/default/files/pictures/MatrixBluePillRedPill.jpg

Asciidoc
Why book writers are switching
to Asciidoc
1. Better UI control
2. Admonitions
3. Macros such as TOC
4. Env. Variables
5. Advanced Table support
6. Page Navigation
7. More….
Asciidoc Reference

Toolset
Github
Asciidoc
AsciidocFx
Atom/Chrome Plugin

Side Note
Github
Wiki
Gollum
Static Site
Generators
staticgen

So, you have an API! Should you leave it at this or also offer a client library/SDK? Using examples from other API providers, this talk will help you decide. We‘ll look at good practices for designing and documenting APIs as well as SDKs, to achieve good developer experience, no matter which choice! This talk was held at "API the Docs" in Paris on April 24th, 2018. https://apithedocs.org/paris2018

What's DSL and what isn't

Leandro Parazito

This presentation shows the concept of a Domain Specific Language in Ruby. A language that aims to solve specific problems, as opposed to general purpose languages that are used to software development in general. A simple syntax language, so natural to read, write and above all things, be easy to understand both for the computer as a human being. Expressing yourself in a language means that the point on semantic is more important to solve specific problems than to their interpreter to know what is going on.

Linq presentation by vaidhesh

Vaidheswaran CS

RoboHelp 2015

Raghuram Pandurangan

Choosing Adobe RoboHelp as Your Help Authoring Tool

Raghuram Pandurangan

DocOps: Documentation at the Speed of Agile

Mary Connor

Presented at Keep Austin Agile 2016: How to we make documentation "Agile", given the Agile Manifesto? How do you get into the Definition of Done? What does "DocOps" mean, in the simplest and broadest terms? What should your requirements be for a DocOps transformation, and how do you find a tool stack that fits them? Where do you start, and how do you escape a waterfall reengineering of your legacy docs?

Using PowerShell as DSL in .Net applications

Joy George

08 jorsek llcGoudron1979

The most hated thing a developer can imagine is writing documentation. But on the other hand nothing can compare with a well sorted documentation, in case you want to change or extend something or just want to get into the topic again. We all know, there is no major way how to do documentation, but there a number of principles and todos which makes it much easier for you. This talk is not about tools, like phpDocumentor, nor is it about promoting a special way of documentation. It is about some of the thoughts you should have gone through, before and when writing documentation.

Rapid development of help files and user documentation in Dr.Explain 5

Dennis Zhuravlev (a.k.a. Crane)

Open Hardware Makers

Leon Anavi

LincDoc Enterprise Edition brochure

Dan O'Leary

Based on brief user input, LincDoc EE engages its advanced business logic engine to swiftly fashion complex documents from a repository of pre-approved language, addenda, paragraphs, sections or other types of business critical data. And with LincDoc EE's granular version tracking, authorized editors can track the entire lifespan of documents and never publish an incorrect version. All documents work together with Laserfiche, can be routed in multiple formats and their data can mesh easily with existing databases.

Writing Effective Self-Help Guides for World Domination

Emma Jane Hogbin Westby

Developers write documentation. Technical authors write manuals. But in a perfect world, your users read software self-help guides. Consumers expect documentation to reflect the sophistication of the software they are using, and will abandon an application if they cannot easily find the answer to their problems. If we really want world domination of free and open source software, we need to have the self-help guides worthy of our code. In "Self Help Guides for World Domination" we'll take a look at the strategies and tools needed for really awesome documentation. Imagine a world where documentation actually helped you to find an answer, or solved one of your problems. If that sounds like a pipe dream, it's because you've had to struggle with too much crap documentation. Technical writing can be fun and accessible, but more importantly, it can be truly useful. By analysing how people use software, and where they stumble, we can drastically improve the experience our users have with our software documentation. Creating relevant documentation needs a little more than just a scraping of code comments though--and this talk will show you how it should be done. Open source tools for writing documentation are very sophisticated, but generally our mastery of them quite simply sucks. Whether they are using DocBook, Mallard or DITA, many projects have opted for very powerful markup languages for their documentation, but often use only a fraction of what the tools can do. Other projects have opted to go with Web-based content management systems and have failed to create a cohesive self-help experience for users. You will learn how to effectively use these common tools for creating and maintaining collaborative documentation. Real examples will be pulled from open source projects. If you've been wanting to help make the user experience better for your project, this talk is a must-see.

Shift Remote: JS - Coding VS Code Extensions - Filip Voska (Infinum)

Shift Conference

A quick talk demonstrating how easy it is to get started with Extension development for Visual Studio Code. We will show you how to create a project, cover basic functionalities offered by the Extension API, and check how you can publish your extension. No longer will you be frustrated when IDE can not automate some boring task that you have to do on a regular basis - you can now automate it yourself!

UNC Chapel Hill 2014 CTC Retreat - Creating epub e books

Jonathan Pletzke

#2 open source introduction

sscholle

VeryPDF .NET PDF Editor SDK for Developers Royalty Free _ VeryPDF Knowledge B...

Lingwen1998

VeryPDF .NET PDF Editor SDK for Developers Royalty Free. Get royalty-free access to a comprehensive PDF toolkit with VeryPDF.NET PDF Editor SDK for Developers. Ideal for .NET applications (C# and VB.NET) and non-managed programs written in Visual Basic 6, Delphi, Microsoft Access, Windev, PHP, Python, Java, JavaScript and more. Experience fast and seamless performance on large documents with the intuitive API that also supports full Unicode. Enjoy a range of valuable features including PDF/A generation, conversion to PDF/A, digital signature support, merging and splitting of PDFs, modification, rasterization, redaction, creation of interactive form fields, PDF layers, and more. Test VeryPDF PDF Editor Web application from following URL, http://online.verypdf.com/app/editor/ VeryPDF PDF Editor OCX Control, https://www.verypdf.com/app/pdf-editor/try-and-buy.html#buy-dev https://www.verypdf.com/app/pdf-editor/pdf-editor-ocx-control.html VeryPDF PDF Viewer OCX Control (ActiveX), https://www.verypdf.com/app/pdf-editor/pdf-viewer-ocx-control-activex.html Online Document Annotator (Annotate Documents Online), https://www.verypdf.com/online/free-pdf-document-annotator-online.php VeryPDF .NET PDF Editor SDK Main features: * Read, Edit, Create or Write PDF documents from file or stream * Convert PDF to PDF/A format with ease * Control the printing process with full support for incremental saving to preserve document history * Fast linearized PDF saving (also known as "Fast Web View") * Interactive PDF features: Actions, document-level navigation and more * Link files with support for file linking * Repair corrupted documents with ease * Pack and compress existing documents to reduce file size by reusing resources * Handle large documents with ease, delivering speed and performance * Achieve 100% compliant and smaller PDF documents through strong objects serialization * Fast text extraction engine available on whole page or ROI * Add, extract and manage fonts in your PDF documents * Add, extract, replace, optimize, or remove bitmaps * Write text with font embedding and full Unicode support * Draw barcodes with ease * Flatten PDF form fields and annotations * Create and edit form fields in your PDF documents * Edit PDF annotations with ease * Full support for PDF transparency schemes for rendering and PDF creation * Graphics state stack and transformation matrix support * Read and write bookmarks * Support for Optional Content Groups (PDF Layers) * Full action support for PDF documents * Manage file attachments with ease * Support for page labelling * Draw pages from a PDF to a page of another PDF * Clone and duplicate pages with ease * Encrypt or secure PDF documents with support for all encryption schemes, from RC4 48 bits to AES 256 bits * Rasterize PDF pages to bitmap with high fidelity rendering and speed * DigiSign documents with support for Adobe PPKMS and Adobe PPKLite modes * Redact sensitive information from PDF documents * Merge, split,

1. Reference management tools.ppt

RanchhodRKhmbhala

Reference management tools for academicc

jhosiyosi2

We4IT Mobile Solutions doclinkr and Aveedo - BLUG/Engage Mobile Conference 2013

We4IT Group

We4IT is a big fans of XPages and 2 of our products are pretty much pure xPages apps - docLinkr (which we’re talking about today) and Aveedo which allows developers to configure their own xPages apps without doing any coding. docLinkr - primary purpose = database mobilisation - used to mobilise existing Notes databases which are then accessed via a *native app* on a smartphone or tablet can mobilise databases in minutes (maximum a few hours) NATIVE APP Aveedo - primary purpose = creating XPages applications - web-enable existing apps (so apps can be accessed in a *browser* on a computer or mobile device) - create new XPages apps or updating existing apps in hours (maximum a few days)

Presentation1f6aim

Docfacto release 2.4

Darren Hudson

code documentationMADUABUM NNANNA

HTML5 Is the Future of Book Authorship

Sanders Kleinfeld

Companion slides for the presentation "HTML5 is the Future of Book Authorship" at Digital Book World 2014. "Combining HTML5 and version control provides key advantages to authors and publishers looking to create and produce books in the brave, new digital world. HTML5-based authoring offers a streamlined production workflow for producing both print and digital outputs, facilitates “digital first” content development, and is a perfect fit for creating a WYSIWYG, Web-based writing experience. Version control enables richer, more streamlined collaboration, ensures a consistent history of changes, and leverages tools used for decades in the software industry. Come learn how O'Reilly is successfully combining these technologies in practice in its own publishing program."

Oreilly동호 김

Introduction to DITAChanaka Palliyaguru

LFC DjangoCon EU

diefenbach

How to create accessible PDFs from Microsoft Word efficiently?

axesPDF

Portfolio for CS 6475 Computational Photography

Senthilkumar Gopal

IBM Index Conference - 10 steps to build token based API Security

Senthilkumar Gopal

Natan Silnitsky

In software engineering, the right architecture is essential for robust, scalable platforms. Wix has undergone a pivotal shift from event sourcing to a CRUD-based model for its microservices. This talk will chart the course of this pivotal journey. Event sourcing, which records state changes as immutable events, provided robust auditing and "time travel" debugging for Wix Stores' microservices. Despite its benefits, the complexity it introduced in state management slowed development. Wix responded by adopting a simpler, unified CRUD model. This talk will explore the challenges of event sourcing and the advantages of Wix's new "CRUD on steroids" approach, which streamlines API integration and domain event management while preserving data integrity and system resilience. Participants will gain valuable insights into Wix's strategies for ensuring atomicity in database updates and event production, as well as caching, materialization, and performance optimization techniques within a distributed system. Join us to discover how Wix has mastered the art of balancing simplicity and extensibility, and learn how the re-adoption of the modest CRUD has turbocharged their development velocity, resilience, and scalability in a high-growth environment.

Vitthal Shirke Microservices Resume Montevideo

Vitthal Shirke

Software Testing Exam imp Ques Notes.pdf

MayankTawar1

Understanding Globus Data Transfers with NetSage

Globus

NetSage is an open privacy-aware network measurement, analysis, and visualization service designed to help end-users visualize and reason about large data transfers. NetSage traditionally has used a combination of passive measurements, including SNMP and flow data, as well as active measurements, mainly perfSONAR, to provide longitudinal network performance data visualization. It has been deployed by dozens of networks world wide, and is supported domestically by the Engagement and Performance Operations Center (EPOC), NSF #2328479. We have recently expanded the NetSage data sources to include logs for Globus data transfers, following the same privacy-preserving approach as for Flow data. Using the logs for the Texas Advanced Computing Center (TACC) as an example, this talk will walk through several different example use cases that NetSage can answer, including: Who is using Globus to share data with my institution, and what kind of performance are they able to achieve? How many transfers has Globus supported for us? Which sites are we sharing the most data with, and how is that changing over time? How is my site using Globus to move data internally, and what kind of performance do we see for those transfers? What percentage of data transfers at my institution used Globus, and how did the overall data transfer performance compare to the Globus users?

Accelerate Enterprise Software Engineering with Platformless

WSO2

Key takeaways: Challenges of building platforms and the benefits of platformless. Key principles of platformless, including API-first, cloud-native middleware, platform engineering, and developer experience. How Choreo enables the platformless experience. How key concepts like application architecture, domain-driven design, zero trust, and cell-based architecture are inherently a part of Choreo. Demo of an end-to-end app built and deployed on Choreo.

Globus Compute wth IRI Workflows - GlobusWorld 2024

Globus

As part of the DOE Integrated Research Infrastructure (IRI) program, NERSC at Lawrence Berkeley National Lab and ALCF at Argonne National Lab are working closely with General Atomics on accelerating the computing requirements of the DIII-D experiment. As part of the work the team is investigating ways to speedup the time to solution for many different parts of the DIII-D workflow including how they run jobs on HPC systems. One of these routes is looking at Globus Compute as a way to replace the current method for managing tasks and we describe a brief proof of concept showing how Globus Compute could help to schedule jobs and be a tool to connect compute at different facilities.

TROUBLESHOOTING 9 TYPES OF OUTOFMEMORYERROR

Tier1 app

Even though at surface level ‘java.lang.OutOfMemoryError’ appears as one single error; underlyingly there are 9 types of OutOfMemoryError. Each type of OutOfMemoryError has different causes, diagnosis approaches and solutions. This session equips you with the knowledge, tools, and techniques needed to troubleshoot and conquer OutOfMemoryError in all its forms, ensuring smoother, more efficient Java applications.

GlobusWorld 2024 Opening Keynote session

Globus

Recently uploaded (20)

Multiple Your Crypto Portfolio with the Innovative Features of Advanced Crypt...

Corporate Management | Session 3 of 3 | Tendenci AMS

Gamify Your Mind; The Secret Sauce to Delivering Success, Continuously Improv...

Developing Distributed High-performance Computing Capabilities of an Open Sci...

Field Employee Tracking System| MiTrack App| Best Employee Tracking Solution|...

Why React Native as a Strategic Advantage for Startup Innovation.pdf

Enhancing Research Orchestration Capabilities at ORNL.pdf

Climate Science Flows: Enabling Petabyte-Scale Climate Analysis with the Eart...

Quarkus Hidden and Forbidden Extensions

How Recreation Management Software Can Streamline Your Operations.pptx

A Comprehensive Look at Generative AI in Retail App Testing.pdf

Dominate Social Media with TubeTrivia AI’s Addictive Quiz Videos.pdf

Beyond Event Sourcing - Embracing CRUD for Wix Platform - Java.IL

Vitthal Shirke Microservices Resume Montevideo

Software Testing Exam imp Ques Notes.pdf

Understanding Globus Data Transfers with NetSage

Accelerate Enterprise Software Engineering with Platformless

Globus Compute wth IRI Workflows - GlobusWorld 2024

TROUBLESHOOTING 9 TYPES OF OUTOFMEMORYERROR

GlobusWorld 2024 Opening Keynote session

How developers write documentation

1. How developers code write @sengopal

2. What is Documentation

3. What is Documentation Material that provides official information or evidence or that serves as a record. Written specification and instructions accompanying a computer program.

4. Aspects READABILITY Available Offline No custom tools Standard Templates EDITOR Available Offline No custom tools Basic In built generators for TOC, tables etc., Reviews DISTRIBUTION Versioned Zero staleness Close to source of truth

5. Available Todayhttps://xkcd.com/927/

6. Google Docs Microsoft Word Wiki O365 What’s the point of this presentation anyway?

7. GITHUB Available Offline No custom tools Versioned and Reviews Close to source of truth Zero staleness Templates - define your own! this←

8. Lingua Franca MARKDOWN Released in 2004 Lightweight markup Plain text formatting Converted to HTML Readme files Online forums ASCIIDOC Released in 2002 Equivalent to DocBook Plain-text mark-up DocBook tool-chain PDF, TeX, manpages, e- books, slides, Git

10.

11. Choicehttp://counterinception.com/sites/default/files/pictures/MatrixBluePillRedPill.jpg

12. Asciidoc Why book writers are switching to Asciidoc 1. Better UI control 2. Admonitions 3. Macros such as TOC 4. Env. Variables 5. Advanced Table support 6. Page Navigation 7. More…. Asciidoc Reference

13. My Toolset

14. Toolset Github Asciidoc AsciidocFx Atom/Chrome Plugin

15. Side Note Github Wiki Gollum Static Site Generators staticgen

16. Questions?

How developers write documentation

Recommended

Recommended

More Related Content

Similar to How developers write documentation

Similar to How developers write documentation (20)

More from Senthilkumar Gopal

More from Senthilkumar Gopal (6)

Recently uploaded

Recently uploaded (20)

How developers write documentation