Technical Documentation Passing the baton

•

0 likes•722 views

The document summarizes a presentation about passing technical skills and standards to newer generations of technical writers. It discusses signs that standards are declining in beginners' work and experienced writers' retaliation to feedback. It emphasizes the importance of respecting the profession, focusing on basics and balance to ensure the "soul" and wholeness are not lost as technical writing evolves. The challenge is to respect oneself, the profession, and focus on fundamentals to smoothly pass skills to new generations.

Baton! Or Legacy? Baton!

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

We shall talk about
• The Focus is on…
• Next Generation: What we expect…
• The Disturbing Sign: Beginners…
• The Unfortunate Sign: Experienced professionals
• Two Manuals: Perspective
• Our Responsibility: The Wholeness
• The Challenge

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

The Focus Is On

• Usability
• XML Basics
• Localization
• Subject-Verb Agreement

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

Next Generation: What We Expect and Foresee
• Technical Expertise
• Documentation Standards and Process
• Ambitious and Visionary

Respect and Pride of being in Community

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

The Disturbing Sign: Beginners
• Social Media Requests
• Emails
• CVs
• Respect?

Disrespectfully Yours and No Regards

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

The Unfortunate Sign: The Experienced Professionals
Two professionals Pro1 and Pro2: Each with 4-5 years of experience as
technical writers, for global companies…

Pro1 Pro2
< –––– Hope
Seeks feedback Retaliates
Despair –––– >

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

The Unfortunate Sign: The Experienced Professionals
Pro1 Welcomes feedback
• Inconsistent Spacing: No use of ‘Styles’ or ‘Paragraph space’
• Contact No.: Contains Email also
• Text Alignment: Justified text for all paragraphs
• Inconsistent Punctuation (use of full stop in lists)
• Inconsistent Alignment of Bullets in Lists
• The text in tables looked bad (font, format, layout, structure)
• And so on.

Thanks.

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

The Unfortunate Sign: The Experienced Professionals
Pro2 Retaliates
• Applied for a
position three
times in eight
months
• I responded
politely this
time
• Pro2 responds
to my email as:

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

User Manual A, developed by Pro1
• The Joy
• Pleasure
• Process
• Fulfillment
• Pride

• The Journey has been Enriching
• The experience is fruitful

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

User Manual B, developed by Pro2
• Usability is fine
• Format is acceptable
• Meets requirements
• Process adhered

The SOUL is Missing 

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

Our Responsibility Is To Ensure That…

Our Bigger hands match well We do not Bypass the Basics
with their Smaller hands… along the way…

Hence, the Balance.

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

The Wholeness…

Hence, the Balance.

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

Passing The Baton

The Challenge
• Challenge or Responsibility?
And… We
• Respect Yourself and Respect the Profession
Resume
• Base. Base. Base.
The
Process

Vinish Garg
STC India Annual Conference 2011, Chennai. 03 December 2011

This is a draft of the presentation that will be given at the HEA Social Sciences annual conference - Teaching forward: the future of the Social Sciences. For further details of the conference: http://bit.ly/1cRDx0p Bookings open until 14 May 2014 http://bit.ly/1hzCMLR or external.events@heacademy.ac.uk ABSTRACT The paper presents the findings of a HEA-CLL funded project focussing on encouraging students to cocreate and use OERs via interdisciplinary study guides on research methods. Students were asked to review the tutor-produced study guides developed on a Google website/wiki and to add resources to the study guide via a comments feature. In focus interviews, they were asked if they were willing to take ownership of the guides. Students’ views on student-led guides indicated an interest in this pedagogical approach, but had issues around trusting their peers’ ability to make reliable judgements. These findings will be explored in our paper.

Technical Documentation Solutions

antugarg

Incorporating Visual Communication in Technical Documentation, for Usability!kate k

Technical documentation and visual clues

tms support solutions ltd

CAD MBD & 3D Technical Documentation

herronje

How to create CAD designs to facilitate collaboration and inter-operability between designers and the rest of the team. Designers, often trapped by looming schedules and inadequate process, need tools to fulfill the demands of collaboration and inter-operability. This presentation will address a set of simple standards and processes that allow designers to include necessary data and modeling standards directly in their CAD models. They are quick and clear instructions that capture the information required by the entire team. This strategy facilitates collaboration among team members such as analysis, parts and materials, manufacturing and configuration management.

Monika Konieczny - Gamification & storytelling: how to turn boring technical ...

soapconf

Language is one of those magic tools that helps us sharing thoughts, ideas, feelings. As we all experience every day it’s not an easy task… You need to be a true wordsmith to make your message clear, easy to understand, and what’s most important generating the appropriate energy in your audience. It’s especially important when you’re a Tech Writer. You have the power to help end user fail in love with the product or hate it and abandon… There’s a wide variety of a daily challenges. One of them is how to write help in a appealing for the user way? Geeky/technical language is extremely boring – most of us hardly ever even start reading the help. But… What if reading help was as exciting as reading a good thriller? What if while learning new feature user would feel as an adventurous explorer solving gripping puzzles? One of the ways to achieve it is to use gamification and storytelling.

Terminology Management Best Practices

SDL

Achim Steinacker: Technical Documentation in the age of Industry 4.0

Semantic Web Company

Jetzt zum #IoT Web Day anmelden: https://aws.amazon.com/de/campaigns/iot-webday/ Das Internet der Dinge ist in aller Munde, doch was versteht man eigentlich unter dem Begriff “Internet of Things”? Und wo liegen die Herausforderungen wenn man Milliarden an Geräten und Billionen von Nachrichten in einem globalen Maßstab unterstützen muss? Antworten auf diese Fragen gibt es in diesem Kurzüberblick. Über AWS IoT informieren: https://aws.amazon.com/de/iot/

Augmenting your Technical Documentation with User-Generated Content

Scott Abel

Presented by Scott Abel at the Society for Technical Communication Summit, June 2, 2008 in Philadelphia. Your user community can be an invaluable source of information about your product or service. Using Web 2.0 technologies, you can augment your existing technical documentation with user-generated content. The presentation will explore the possibilities, as well as the perils, of leveraging this often-overlooked resource.

Plan lector paco yunquejuan antonio cupe cuenca

Writing Beautiful Technical Documentation

Lana Brindley

DDS for Internet of Things (IoT)

Abdullah Ozturk

Better Manufacturing Work Instructions and Technical Documentation with Dozuki

Dozuki Software

The approach to work instructions and standardized procedures (SOPs) used in manufacturing hasn't changed in decades – until now. Dozuki's software tool makes it easy to create, manage, and distribute documentation to your line operators and technicians, wherever they may be. Use mobile devices or any internet connected computer to retrieve or modify your documentation. The next big breakthrough in manufacturing operations is here: http://www.dozuki.com/solutions/electronic-work-instructions/

The Prospect of IoT in the Oil & Gas

Ghazi Wadi, PMP

Internet of Things: an overview

Pascal Bodin

Internet of Things (IoT) Costs, Connectivity, Resources and Software

Real-Time Innovations (RTI)

Embedded systems are becoming interconnected and accessible via the internet. Gartner Group estimates there will be nearly 26 billion devices that make up the Internet of Things by 2020. This results in a massive variety of connected devices with varying security, reliability, and authentication requirements. Cost sensitivity also figures into the equation. This mix of requirements and costs require IoT developers to identify sensor, processor, and software solutions that address the requirements and hit required price points. Join us as IoT solution experts discuss sensors, connectivity, processors, platforms, and software for IoT applications and overview applications of IoT in various markets. Watch for free on-demand http://ecast.opensystemsmedia.com/511

IoT summit - Building flexible & secure IoT solutions

Eric Larcheveque

Disruptive Innovation

korzay

Building Smart Cities with Everything as a Service

Syam Madanapalli

Disruptive innovationRaymond Ebbeler

Organizational Creativity

Glenn Griffin

The Internet of Cars - Towards the Future of the Connected Car

Jorgen Thelin

No doubt you have heard the phrase “Internet of Things” and the new buzzword “IoT” been used more and more these days, but what does that mean in practice? The Tesla Model S is probably the most well-connected car on the planet at the moment, and in this presentation we will use that vehicle as a case study of some practical usage of IoT concepts and technology that is already being applied to modern automobiles.How far away are we from a future “Internet of Cars” and what will be the social and privacy impacts of more connected-car scenarios?

Creative organisation

David Memorial Institute of Management

10 disruptive innovationWesley Shu

Disruptive InnovationWesley Shu

The Impact of IoT on Cloud Computing, Big Data & Analytics

Syam Madanapalli

IoT Applications are different from typical enterprise applications; and most of the companies are hijacking what the IoT is depending on the what products/solutions they offer. I put up my point of view on how the IoT impacts the traditional Cloud Computing and Big Data Analytics. The takeaway from this presentation is IoT requires realtime computing as the data moves from the physical world to the cyber world (Cloud) to take actions at spatiotemporal location.

Systems driven content supply chain for the customer experience

Vinish Garg

Content strategy is an extension of the brand narrative: My keynote at the Ut...

Vinish Garg

Viewers also liked

Internet Of Things

johnson jawahar

IoT Breakfast - AWS Amazon Web Services - Internet of Things

AWS Germany

Augmenting your Technical Documentation with User-Generated Content

Scott Abel

Plan lector paco yunquejuan antonio cupe cuenca

Writing Beautiful Technical Documentation

Lana Brindley

DDS for Internet of Things (IoT)

Abdullah Ozturk

Better Manufacturing Work Instructions and Technical Documentation with Dozuki

Dozuki Software

The Prospect of IoT in the Oil & Gas

Ghazi Wadi, PMP

Internet of Things: an overview

Pascal Bodin

Internet of Things (IoT) Costs, Connectivity, Resources and Software

Real-Time Innovations (RTI)

IoT summit - Building flexible & secure IoT solutions

Eric Larcheveque

Disruptive Innovation

korzay

Building Smart Cities with Everything as a Service

Syam Madanapalli

Disruptive innovationRaymond Ebbeler

Organizational Creativity

Glenn Griffin

The Internet of Cars - Towards the Future of the Connected Car

Jorgen Thelin

Creative organisation

David Memorial Institute of Management

10 disruptive innovationWesley Shu

Disruptive InnovationWesley Shu

The Impact of IoT on Cloud Computing, Big Data & Analytics

Syam Madanapalli

Viewers also liked (20)

Internet Of Things

IoT Breakfast - AWS Amazon Web Services - Internet of Things

Augmenting your Technical Documentation with User-Generated Content

Plan lector paco yunque

Writing Beautiful Technical Documentation

DDS for Internet of Things (IoT)

Better Manufacturing Work Instructions and Technical Documentation with Dozuki

The Prospect of IoT in the Oil & Gas

Internet of Things: an overview

Internet of Things (IoT) Costs, Connectivity, Resources and Software

IoT summit - Building flexible & secure IoT solutions

Disruptive Innovation

Building Smart Cities with Everything as a Service

Disruptive innovation

Organizational Creativity

The Internet of Cars - Towards the Future of the Connected Car

Creative organisation

10 disruptive innovation

Disruptive Innovation

The Impact of IoT on Cloud Computing, Big Data & Analytics

Recently uploaded

Monitoring Java Application Security with JDK Tools and JFR Events

Ana-Maria Mihalceanu

GraphRAG is All You need? LLM & Knowledge Graph

Guy Korland

Guy Korland, CEO and Co-founder of FalkorDB, will review two articles on the integration of language models with knowledge graphs. 1. Unifying Large Language Models and Knowledge Graphs: A Roadmap. https://arxiv.org/abs/2306.08302 2. Microsoft Research's GraphRAG paper and a review paper on various uses of knowledge graphs: https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/

LF Energy Webinar: Electrical Grid Modelling and Simulation Through PowSyBl -...

DanBrown980551

Do you want to learn how to model and simulate an electrical network from scratch in under an hour? Then welcome to this PowSyBl workshop, hosted by Rte, the French Transmission System Operator (TSO)! During the webinar, you will discover the PowSyBl ecosystem as well as handle and study an electrical network through an interactive Python notebook. PowSyBl is an open source project hosted by LF Energy, which offers a comprehensive set of features for electrical grid modelling and simulation. Among other advanced features, PowSyBl provides: - A fully editable and extendable library for grid component modelling; - Visualization tools to display your network; - Grid simulation tools, such as power flows, security analyses (with or without remedial actions) and sensitivity analyses; The framework is mostly written in Java, with a Python binding so that Python developers can access PowSyBl functionalities as well. What you will learn during the webinar: - For beginners: discover PowSyBl's functionalities through a quick general presentation and the notebook, without needing any expert coding skills; - For advanced developers: master the skills to efficiently apply PowSyBl functionalities to your real-world scenarios.

Observability Concepts EVERY Developer Should Know -- DeveloperWeek Europe.pdf

Paige Cruz

Monitoring and observability aren’t traditionally found in software curriculums and many of us cobble this knowledge together from whatever vendor or ecosystem we were first introduced to and whatever is a part of your current company’s observability stack. While the dev and ops silo continues to crumble….many organizations still relegate monitoring & observability as the purview of ops, infra and SRE teams. This is a mistake - achieving a highly observable system requires collaboration up and down the stack. I, a former op, would like to extend an invitation to all application developers to join the observability party will share these foundational concepts to build on:

State of ICS and IoT Cyber Threat Landscape Report 2024 preview

Prayukth K V

The IoT and OT threat landscape report has been prepared by the Threat Research Team at Sectrio using data from Sectrio, cyber threat intelligence farming facilities spread across over 85 cities around the world. In addition, Sectrio also runs AI-based advanced threat and payload engagement facilities that serve as sinks to attract and engage sophisticated threat actors, and newer malware including new variants and latent threats that are at an earlier stage of development. The latest edition of the OT/ICS and IoT security Threat Landscape Report 2024 also covers: State of global ICS asset and network exposure Sectoral targets and attacks as well as the cost of ransom Global APT activity, AI usage, actor and tactic profiles, and implications Rise in volumes of AI-powered cyberattacks Major cyber events in 2024 Malware and malicious payload trends Cyberattack types and targets Vulnerability exploit attempts on CVEs Attacks on counties – USA Expansion of bot farms – how, where, and why In-depth analysis of the cyber threat landscape across North America, South America, Europe, APAC, and the Middle East Why are attacks on smart factories rising? Cyber risk predictions Axis of attacks – Europe Systemic attacks in the Middle East Download the full report from here: https://sectrio.com/resources/ot-threat-landscape-reports/sectrio-releases-ot-ics-and-iot-security-threat-landscape-report-2024/

FIDO Alliance Osaka Seminar: The WebAuthn API and Discoverable Credentials.pdf

FIDO Alliance

GenAISummit 2024 May 28 Sri Ambati Keynote: AGI Belongs to The Community in O...

Sri Ambati

Alt. GDG Cloud Southlake #33: Boule & Rebala: Effective AppSec in SDLC using ...

James Anderson

Effective Application Security in Software Delivery lifecycle using Deployment Firewall and DBOM The modern software delivery process (or the CI/CD process) includes many tools, distributed teams, open-source code, and cloud platforms. Constant focus on speed to release software to market, along with the traditional slow and manual security checks has caused gaps in continuous security as an important piece in the software supply chain. Today organizations feel more susceptible to external and internal cyber threats due to the vast attack surface in their applications supply chain and the lack of end-to-end governance and risk management. The software team must secure its software delivery process to avoid vulnerability and security breaches. This needs to be achieved with existing tool chains and without extensive rework of the delivery processes. This talk will present strategies and techniques for providing visibility into the true risk of the existing vulnerabilities, preventing the introduction of security issues in the software, resolving vulnerabilities in production environments quickly, and capturing the deployment bill of materials (DBOM). Speakers: Bob Boule Robert Boule is a technology enthusiast with PASSION for technology and making things work along with a knack for helping others understand how things work. He comes with around 20 years of solution engineering experience in application security, software continuous delivery, and SaaS platforms. He is known for his dynamic presentations in CI/CD and application security integrated in software delivery lifecycle. Gopinath Rebala Gopinath Rebala is the CTO of OpsMx, where he has overall responsibility for the machine learning and data processing architectures for Secure Software Delivery. Gopi also has a strong connection with our customers, leading design and architecture for strategic implementations. Gopi is a frequent speaker and well-known leader in continuous delivery and integrating security into software delivery.

zkStudyClub - Reef: Fast Succinct Non-Interactive Zero-Knowledge Regex Proofs

Alex Pruden

This paper presents Reef, a system for generating publicly verifiable succinct non-interactive zero-knowledge proofs that a committed document matches or does not match a regular expression. We describe applications such as proving the strength of passwords, the provenance of email despite redactions, the validity of oblivious DNS queries, and the existence of mutations in DNA. Reef supports the Perl Compatible Regular Expression syntax, including wildcards, alternation, ranges, capture groups, Kleene star, negations, and lookarounds. Reef introduces a new type of automata, Skipping Alternating Finite Automata (SAFA), that skips irrelevant parts of a document when producing proofs without undermining soundness, and instantiates SAFA with a lookup argument. Our experimental evaluation confirms that Reef can generate proofs for documents with 32M characters; the proofs are small and cheap to verify (under a second). Paper: https://eprint.iacr.org/2023/1886

Assure Contact Center Experiences for Your Customers With ThousandEyes

ThousandEyes

Video Streaming: Then, Now, and in the Future

Alpen-Adria-Universität

In his public lecture, Christian Timmerer provides insights into the fascinating history of video streaming, starting from its humble beginnings before YouTube to the groundbreaking technologies that now dominate platforms like Netflix and ORF ON. Timmerer also presents provocative contributions of his own that have significantly influenced the industry. He concludes by looking at future challenges and invites the audience to join in a discussion.

Pushing the limits of ePRTC: 100ns holdover for 100 days

Adtran

Quantum Computing: Current Landscape and the Future Role of APIs

Vlad Stirbu

FIDO Alliance Osaka Seminar: FIDO Security Aspects.pdf

FIDO Alliance

SAP Sapphire 2024 - ASUG301 building better apps with SAP Fiori.pdf

Peter Spielvogel

Building better applications for business users with SAP Fiori. • What is SAP Fiori and why it matters to you • How a better user experience drives measurable business benefits • How to get started with SAP Fiori today • How SAP Fiori elements accelerates application development • How SAP Build Code includes SAP Fiori tools and other generative artificial intelligence capabilities • How SAP Fiori paves the way for using AI in SAP apps

Epistemic Interaction - tuning interfaces to provide information for AI support

Alan Dix

Paper presented at SYNERGY workshop at AVI 2024, Genoa, Italy. 3rd June 2024 https://alandix.com/academic/papers/synergy2024-epistemic/ As machine learning integrates deeper into human-computer interactions, the concept of epistemic interaction emerges, aiming to refine these interactions to enhance system adaptability. This approach encourages minor, intentional adjustments in user behaviour to enrich the data available for system learning. This paper introduces epistemic interaction within the context of human-system communication, illustrating how deliberate interaction design can improve system understanding and adaptation. Through concrete examples, we demonstrate the potential of epistemic interaction to significantly advance human-computer interaction by leveraging intuitive human communication strategies to inform system design and functionality, offering a novel pathway for enriching user-system engagements.

DevOps and Testing slides at DASA Connect

Kari Kakkonen

Climate Impact of Software Testing at Nordic Testing Days

Kari Kakkonen

My slides at Nordic Testing Days 6.6.2024 Climate impact / sustainability of software testing discussed on the talk. ICT and testing must carry their part of global responsibility to help with the climat warming. We can minimize the carbon footprint but we can also have a carbon handprint, a positive impact on the climate. Quality characteristics can be added with sustainability, and then measured continuously. Test environments can be used less, and in smaller scale and on demand. Test techniques can be used in optimizing or minimizing number of tests. Test automation can be used to speed up testing.

FIDO Alliance Osaka Seminar: Overview.pdf

FIDO Alliance

Leading Change strategies and insights for effective change management pdf 1.pdf

OnBoard

Recently uploaded (20)