Tata AIG General Insurance Company - Insurer Innovation Award 2024
Generative AI for Technical Writer or Information Developers
1. Generative AI for TWs
Workshop
Conducted at Tech Write Pro
2nd Conference
-Raghuram Pandurangan
PayU India
2. About me
With more than two decades of experience in technical writing, I am dedicated to helping
organizations and writers overcome their challenges. My expertise includes adopting authoring
tools, Documentation Strategy, and automating review and publishing workflows. I have for 22+
years of experience specializing in Healthcare IT and Fintech.
Earlier, served as a STC India Chapter volunteer in various roles such as Vice President (2 years)
and Membership Manager (4 years). Currently, serving as Core member of Tech Write Pro. I am
the owner and moderator of the Technical Writer Forum group on LinkedIn with ~53K members,
where I facilitate active discussions without promotions or spam.
2
4. Artificial Intelligence
1956
Artificial Intelligence
The field of computer science that seeks to create
intelligent machines that can replicate or exceed
human intelligence
Machine Learning
1997
Machine Learning
Subset of AI that enables machines to learn from
existing data and improve upon that data to make
decisions or predictions
Deep Learning
2017
Deep Learning
A machine learning technique in which layers of neural
networks are used to process data and make decisions
Generative AI
2021
Create new written, visual, and auditory content given
prompts or existing data
1956
5. Advantages of Gen AI
• Improved Content Generation
• Faster Document Production
• Time and Cost Savings
• Multilingual Capabilities
5
6. Limitations
• Quality and Coherence
• Bias and Fairness
• Control and Fine-Tuning
• Ethical Issues
• "Resistance to Change"
6
8. Process of designing, refining, and
optimizing input prompts to guide a
model toward producing more accurate
outputs while keeping cost efficiency
Prompt Engg.
9. Instruction
Input data
Context
Target format
Example
Cue
Write a product launch email for new headphones.
<
This product is AI-powered and priced at $79.99.
The tone is friendly and exciting.
Output as a JSON object with "subject" and "body" fields.
Example:
{
"subject": "Introducing Our New AI-Powered Headphones!",
"body": "We are thrilled to announce the launch of our new AI-
powered headphones"
}
Output:
<
Prompt Anatomy
11. • Start with clear instructions and repeat the
instructions at the end
• Add clear syntax: headers, separators
• Break the task down
• Adjust parameters: Temperature and Top
probabilities
Recommendations
12. (token limit)
Large Text
Beyond
Token
Limit
Chunks
Please summarize and extract topic: Global warming refers to
the gradual increase in the overall temperature of the Earth's
atmosphere, primarily caused by the burning of fossil fuels
such as coal, oil, and natural gas. This burning releases
carbon dioxide and other greenhouse gases into the
atmosphere, which trap heat and cause the Earth's
temperature to rise.
Climate change is a pressing issue that needs to be addressed
immediately. Governments around the world need to take
immediate action to reduce carbon emissions and invest in
renewable energy sources. Failure to do so will have dire
consequences for future generations
The text is discussing global warming, which is the gradual increase in
the overall temperature of the Earth's atmosphere caused by the
burning of fossil fuels. This burning releases greenhouse gases, such
as carbon dioxide, into the atmosphere which trap heat and cause the
temperature to rise. The text also highlights the urgency of the issue
of climate change and the need for governments to take action to
reduce carbon emissions and invest in renewable energy sources.
Failure to address this issue will have negative consequences for
future generations.
Topic: Climate change and Global warming.
Continue to
next prompt
Please summarize the following text:
'Climate change is a pressing issue that
needs to be addressed immediately. The
increasing levels of carbon dioxide in the
atmosphere are causing the Earth's
temperature to rise, which is leading to
more frequent and severe natural disasters.
Governments around the world need to take
immediate action to reduce carbon
emissions and invest in renewable energy
sources. Failure to do so will have dire
consequences for future generations'"
Climate change is a pressing issue that needs to
be addressed immediately. Governments
around the world need to take immediate
action to reduce carbon emissions and invest in
renewable energy sources. Failure to do so will
have dire consequences for future generations
Prompt Chunking
13. Meet my team
Feedback, FAQs, New
topics,
Sample Code or
Walkthroughs
Campaign Posters/
Videos
Instructional
Videos
Paraphrasing
13
Rewording.io
14. Tool / Cost/month Billed Monthly Billed Yearly
ChatGPT $20 Not available
Bing Copilot 2000 Not available
Canva Not available 3999
Invideo.io
(50 mins video) $25 $20
Quillbot $9.95 $4.17
Licensing
14
15. • Content that has been generated by an AI system and
may contain errors, inconsistencies, or outdated
information.
• Always, thoroughly verify the content Generated by AI
• AI can pick content from anywhere so it can be from your
competitor too
• Always try prompting AI with your existing documentation
for better accuracy
15
17. ● Helps generate an outline for your documentation
● Based on the target audience, helps tailor the language and tone of the
content.
● Recommendations on whether to use simpler language.
● Suggests authoring or screen capture tools based on your team’s needs.
● Helps you with sample content – Writer’s block
● Assist in drafting introductory paragraphs, summaries, and other
essential parts.
Analysis & Planning
19. ● Generate technical content based on prompts.
● Writers input bare-bones project details, and GenAI produces relevant
documentation.
● Augments domain-specific knowledge with automated writing
capabilities.
● You must oversee AI-generated content
Automation
20. ● Use GenAI for mundane tasks like:
○ Release Notes from Trouble Ticketing tools like JIRA (Example)
○ FAQs from Support tickets (Example)
○ Product Descriptions
○ Standard Operating Procedures (Example)
● Create FAQs based on existing documentation
Mundane Content
21. ● Recruiters take only 30s to scan your resume
● Most of the resumes are filtered by ATS (AI)
● Use Generative AI to create:
○ Custom Resumes based on JD
○ Custom Cover Letter based on JD
Resume &
Cover Letter
24. FAQs
Step 1: Choose the source Step 2: Prompt
• Choose only the released content
as source
• Support tickets pasted in prompt if it does
not have customer information or your
organization permits you to...
Repeat the flow for several programming
languages to use for a single recipe
Pitch deck title
24
Step 3: Review
• Review thoroughly and
rephrase
• Add hyperlinks
• Review it with SME
25. FAQ Prompt Example
Could you help me with FAQs for
Installing Citrix StoreFront based
on the following technical
documentation:
https://docs.citrix.com/en-
us/storefront/2203-ltsr/install-
standard/install
25
26. ● Convert cURL requests to other language bindings
● Check the accuracy of API requests in cURL or any other language
binding
● Create code walkthroughs of API requests in most used language
binding for basic to expert developers
Developer Docs
27. Code Walkthroughs - DevExp
Handholding made easy
Language Bindings
Prompt with your exact requirement and
include the cURL, response to be parsed,
etc.
Repeat the flow for several programming
languages to use for a single recipe
Pitch deck title
27
32. Blog Posts
Pitch deck title
32
Find yourself stuck, not knowing how to
begin your blog post, use brainstorming
feature of Notion AI. It is useful when faced
with starting that dreaded first draft!
Creating an outline
Ask for an article skeleton. Here is my
simple prompt:
Could help with an outline for a blog on
Challenges with implementing Generative
AI in technical writing?
Brainstorming
Certainly! Here's an outline for a blog on
the challenges of implementing Generative
AI in technical writing...
33. Blog Outline: Response
**Title: Challenges of Implementing Generative AI in Technical
Writing**
**Introduction:**
- Brief overview of Generative AI and its applications in various
fields.
- Explanation of how Generative AI is being explored in technical
writing to automate content generation.
**1. Complexity of Technical Content:**
- Discuss the intricate nature of technical writing, which often
involves conveying complex concepts and procedures.
- Explain how Generative AI may struggle to comprehend and
accurately generate technical content due to its complexity and
specificity.
**2. Domain-Specific Knowledge:**
- Highlight the importance of domain-specific knowledge in technical
writing, where familiarity with specialized terminology and concepts is
crucial.
- Explain the challenge of training Generative AI models to understand
and utilize domain-specific knowledge effectively.
**3. Maintaining Consistency and Accuracy:**
- Discuss the importance of consistency and accuracy in technical
documentation to ensure clarity and reliability.
- Address the challenge of maintaining consistency and accuracy when
using Generative AI, which may produce content that lacks coherence
or contains inaccuracies.
Pitch deck title
33
34. Blog Outline: Response [Contd.]
**4. Contextual Understanding:**
- Explore the difficulty of teaching Generative AI models to comprehend
the context surrounding technical content, such as user intent, audience
demographics, and situational relevance.
- Discuss the potential implications of context misunderstanding,
including inappropriate content generation or misinterpretation of
user queries.
**5. Ethical Considerations:**
- Address the ethical implications of using Generative AI in technical
writing, including concerns related to misinformation, bias amplification,
and plagiarism.
- Discuss the responsibility of organizations and practitioners to implement
ethical guidelines and safeguards when leveraging Generative AI for content
generation.
**6. Integration Challenges:**
- Highlight the technical and logistical challenges associated with integrating Generative
AI tools into existing technical writing workflows and platforms.
- Discuss the need for seamless integration, interoperability,
and customization to accommodate diverse use cases and user requirements.
**Conclusion:**
- Summarize the key challenges of implementing Generative AI
in technical writing, including complexity, domain-
specificity, consistency, contextual understanding, ethical considerations, and integration
challenges.
- Emphasize the importance of addressing these challenges
through ongoing research, innovation, and collaboration between
AI developers, technical writers, and domain experts.
Pitch deck title
34
38. Publishing
Pitch deck title
38
● SEO Optimization is the best use case
● Helps you with Metadata description for each
page/topic
● Assist in proofreading and identifying textual
errors.
39. Publishing
Pitch deck title
39
● GenAI can aid in translating content into different
languages.
● It helps adapt documentation for global
audiences.
● For FAQs, help articles, or chatbots, GenAI
responds in real time.
40. Search Chatbot
Embed chatbot to your help website and
reduce the L1/L2 support queries. It
skims the content and presents the
answers to the questions very well
including sample codes.
40
41. Some other use cases....
Prompt-based writing Rewriting
Prompt.AI and AI Dungeon create random
prompts or scenarios
By writing in response to prompts, writers can get
past their creative blocks and come up with new
ideas.
Quillbot and Hemingway Editor
offers different ways to put sentences
together or different words to use.
Mind mapping & Idea Generation Overcoming Psychological Barriers
MindMeister or Miro organize your
thoughts and visualizing the connections
between different ideas.
Get past mental blocks of self-doubt by
giving feedback and encouragement that is
based on facts.
41
43. Invideo.io overview
Quick
Generate videos in 3-5
mins with just a prompt
Deliver fast
You can easily deliver up
to 5 videos/day.
Variety
Create videos for
• Explanation
• Shorts
Authentic
Generates based on:
• Article or content you
provide
• Existing learning
43
45. How to create a
video?
1. Identify source
2. Video style
3. Prompt and Settings
4. Edit
5. Download & Publish
Pitch deck title 45
46. 46
TW
Step 1: Identify
Source
• Raw text
• Along with URLs of:
o Article
o Blog
o Help documentation (available to
public)
o Website page
47. Step 2: Select
Video Style
• Choose the workflow according to
length and target audience:
48. Step 3: Prompt
and Settings
• Select the duration
• Prompt with the source URL or
enter the requirement in short
• Click
48
49. Wait for the
video to
Generate...
If not responding:
• Check if the URL provided is not
behind firewall or not opening
• Try changing the prompt
• Provide only one URL with prompt to
avoid confusing the AI
49
50. 50
Step 4: Edit
• Use prompts to edit
o "In scene 2, remove the mention
or reference of "…."
o "Remove scene 2"
• Update the scenes to
include custom
images/screenshots
• Regenerate if required
51. 51
Step 5: Download
& Publish
• Select the following settings:
o Stock images watermarks for education
o Subtitles
o Resolution – 1080p ideal for YouTube
52. Example
Create an instructional video for the
following procedure to install Citrix
Storefront:
https://docs.citrix.com/en-us/storefront/2203-
ltsr/install-standard/install
52
Confirmation message:
Create a 3 minutes youtube video about Create an instructional
video for the following procedure to install Citrix Storefront:
https://docs.citrix.com/en-us/storefront/2203-ltsr/install-
standard/install. Settings: Use a female young Indian voice. Use
Tech Write Pro Webinar as watermark text.
Result: https://ai.invideo.io/watch/-vRnet-H8Df
54. TW Best Practices Example
TW Collaboration
Refer the following pages and
create a video on how technical
writers must collaborate with
various teams in an organization:
https://clickhelp.com/clickhelp-
technical-writing-
blog/collaboration-between-
technical-writers-and-developers/
https://www.helpscout.com/help
u/support-technical-writers/
Correction #1
Remove the mention on
ClickHelp at the end of Chapter
2
Correction #2
Include the emphasis
of Integrate Documentation Into
Development Cycles at the end
of Chapter 3 as
in https://clickhelp.com/clickhel
p-technical-writing-
blog/collaboration-between-
technical-writers-and-
developers/
54
Result: https://youtu.be/nUbnlYxc5is
55. Summary
• Embrace AI to use the right tools for each use
case which are you are comfortable with.
• Do not overdo
• Always validate the generated content by yourself
or the right SME before making it available to
your customers.
• Educate your organization with its benefits if they
feel it is misuse
55
57. Thank you
Connect with me:
www.linkedin.com/in/raghuram7
7
My YouTube Channel
https://www.youtube.com/chan
nel/UCfz3ZZZgMg8hNg1UUtIX
Qdg
Generative AI for TWs 57
https://collager.ai/
59. •
• Tokens can sometimes be counter-intuitive
• Tabular data is space-efficient
Editor's Notes
Generating Ideas and Prompts:
Technical writers often need inspiration to kickstart their creative process. GenAI can generate ideas and prompts, helping writers overcome writer’s block and explore fresh angles for their content.
Improved Grammar and Syntax:
GenAI tools can assist in refining grammar and sentence structure. By analyzing existing content, they suggest improvements, ensuring high-quality writing.
Spelling and Proofreading:
Automated spelling and proofreading features save time and reduce errors. Technical writers can focus on content without worrying about typos or grammatical slip-ups.
Content Optimization:
GenAI can analyze existing technical documents and recommend optimization strategies. Whether it’s improving readability, SEO, or adherence to style guides, this technology streamlines content enhancement.
Generating Code and Technical Documentation:
For technical writers dealing with code snippets or complex technical explanations, GenAI can generate accurate code examples, explanations, and documentation. It significantly speeds up the writing process.
Personalized Content:
GenAI allows customization based on user preferences. Technical writers can create personalized content for different audiences, tailoring their documentation to specific needs.
Cross-Cultural Communication:
In a globalized world, technical writers often cater to diverse audiences. GenAI can help adapt content for different cultural contexts, ensuring effective communication.
Collaborative Writing:
GenAI tools facilitate collaboration among writers. Multiple team members can work on the same project, maintaining consistency and coherence across documents.
Quality and Coherence: Writers must review AI-generated content for accuracy and coherence.
Bias and Fairness: GenAI may inadvertently perpetuate biases present in training data.
Control and Fine-Tuning: Writers need to fine-tune AI models to align with specific requirements.
Lack of Creativity: While GenAI excels at structured content, creative elements still require human input.
Resource Intensiveness: Implementing GenAI may require computational resources and expertise12.
Then all summaries are passed to GPT again to summarize, i.e. second round of summarization. The sum of the summaries has to fit within the token limit.
If you provide specific content, I can propose a logical flow for presenting it.
Target audience can be technical experts, end-users, etc.)
Creates A placeholder text or examples for different sections.
This automation saves time and accelerates content creation.
Oversee to ensure accuracy and quality.
Writers can focus on higher-value tasks while GenAI handles routine content.
Writers can focus on higher-value tasks while GenAI handles routine content.
Writers can focus on higher-value tasks while GenAI handles routine content.
Help me with the code walkthrough for the following code snippet in Python language binding for PayU Hosted Checkout Integration:
import requestsurl = "https://test.payu.in/_payment"payload = "key=JP***g&txnid=Dnh8wYimuCRIdv&amount=10.00&firstname=PayU User&email=test@gmail.com&phone=9876543210&productinfo=iPhone&pg=&bankcode=&surl=https://apiplayground-response.herokuapp.com/&furl=https://apiplayground-response.herokuapp.com/&hash=cb4b8bda5677dbe80f53735b1d0ec5d48164c3654627369268cf6bf266db994db39108ce2e0868c953e66c172f6b2d78836b253d3463d0cc40d9b6a93118ed56"headers = { "Accept": "application/json", "Content-Type": "application/x-www-form-urlencoded" }response = requests.request("POST", url, data=payload, headers=headers, params=querystring)print(response.text)
Gen AI are Ideal for chatbot
Rewriting: It looks at your work and tell you how to make it clearer, shorter, and easier to read. By using tools to rearrange and rewrite sentences, writers can get past writer’s block and make their content move better.
Mind mapping: By creating digital mind maps, writers can brainstorm ideas, outline their content, and overcome the mental blocks that hinder their creativity.
Psychological barries: AI writing assistants make helpful ideas and point out places where writing could be better. This gives writers more confidence in their writing. Writers can get over self-doubt and perfectionism by realizing that AI is a tool to boost human creation, not replace it.
Rewriting: It looks at your work and tell you how to make it clearer, shorter, and easier to read. By using tools to rearrange and rewrite sentences, writers can get past writer’s block and make their content move better.
Mind mapping: By creating digital mind maps, writers can brainstorm ideas, outline their content, and overcome the mental blocks that hinder their creativity.
Psychological barries: AI writing assistants make helpful ideas and point out places where writing could be better. This gives writers more confidence in their writing. Writers can get over self-doubt and perfectionism by realizing that AI is a tool to boost human creation, not replace it.
YouTube Explainer for instructional or overview videos
Others can be used for promos
Ideal duration:
3-4 mins for instructional videos
2-3 mins for overview video
Voice: Recommended to use Indian male or female voice for Indian audience
Select the stock images usage More stock images you use for commercial use > pay more
X mark is displayed in any of the following if AI is not able to understand your prompt:
Analysis
Still thinking
Play multiple times
Update the script
Read it scene-by-scene
Update it
Repeat Step 1
Select Download from Export drop-down menu
Select the settings
Click Continue
Publish the downloaded MP4 file:
YouTube (recommended for analytics)
LinkedIn
Facebook
Instagram