![Demystifying Search: Making your
help content search friendly [Contd.]
The Search Engine process to rank pages
Crawler crawls through the pages
Traffic to your page is a factor for ranking
Points to remember
Keywords used by as many customers does not necessarily
increase the views.
The low weighed keywords may be good enough](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-5-2048.jpg)
![Demystifying Search: Making your help
content search friendly [Contd.]
Focus Areas in Optimization
Keywords: put those keyword tags around the text
Introduction: put them in the introduction of content or first page. It must not contain
unnecessary information
Home Page: should have cross-reference to all the pages to get better page rank.
Page links: it exhibits the relative importance of pages. Do not overdo with too much links.
Keywords
Figure out search terms that readers might use
Identify keywords (based on “Search” terms)
Use those keywords in topics
Remember not to use
jargons
irrelevant keywords
unnecessary words inside the content
maintain consistency (do not use synonyms or long list of words for the same term)](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-6-2048.jpg)
![Demystifying Search: Making your help
content search friendly [Contd.]
Tags
Search engines focus on text within special tags
Introductory text of the page
Page title
Text inside the Hyperlink
Subheadings
Tag the non-textual content (Screenshots, Multimedia, Videos,
etc.) with the keywords
Search engines understand only text
Translate the media content to words
Introductory Text
30% Search Engines decide based on text in Hyperlinks
45% Search Engines decide based on first sentence](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-7-2048.jpg)
![Demystifying Search: Making your help
content search friendly [Contd.]
Home Page
Entry point to the key sections
Place important content on Home page - with keywords in the
Hyperlink text
Core Tasks and Concepts
Overview and high-level tasks
Architecture diagrams
Tutorials and Scenarios…
Do not put too much links in the Home page](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-8-2048.jpg)
![Demystifying Search: Making your
help content search friendly [Contd.]
Hyperlinks
The topic in the search result may not be what reader was looking for.
No. of hyperlinks pointing to a topic measure the importance of topic
The Hyperlinks include:
Regular Hyperlinks or Cross-references
Tweets
Every instance of “Share” page in the Social Media Network.
Content Structure
Remove barriers to indexing’
Make it easy for Search engines to crawl](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-9-2048.jpg)
![Demystifying Search: Making your help
content search friendly [Contd.]
Search engines rank increases with:
Site Map
TOC and Help with hierarchy
Topics with size of 300-500 words, else ignored
Help architecture
Internal navigation and linking is text-based
No broken links
No missing pages
Easy navigation](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-10-2048.jpg)
![Demystifying Search: Making your
help content search friendly [Contd.]
Monitor the Search Optimization is important
Use Search Analytic Tools
Submit Online Help URL
Search terms, phrases used by Readers
Topics Browsed
Topics cannot be found
• See the Reports in a regular basis](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-11-2048.jpg)
![Mobile Documentation: Create ePubs and
Other Mobile Device Outputs [Contd.]
Images or Screenshots
Include detailed alternate text: Speech Recognition
Put the alt text in <Img> tag
Tools
RoboHelp : Device-sensitive content
epub3: New std. output for eBook readers and mobile devices
Mobi: compatible with Kindle and others](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-14-2048.jpg)
![How to Develop Mobile Help [Contd.]
Refer this Book:
Help Considerations
Small screen size
Simple language
Concise content
Primary and secondary content
Use of
Graphics – sparingly and wherever
required only
Hyperlinks
Fonts
Navigation techniques
No. of clicks
Orientation](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-17-2048.jpg)
![How to Develop Mobile Help [Contd.]
It is 108% tougher to read on Mobile device*
Tools & Technologies for Mobile Documentation
Javascript: Used for RUN applications
RoboHelp: HTML output for Android and other mobile platforms
Site Analytics: Adobe’s tool for seeing the usage analytics
Publishing & Mapping
Mobile Help using RoboHelp
For browser-based
Help files can be hosted in the Server
The URL is called from the application on the RUN
Challenges
Understanding how mobile apps work
Finding examples for us to read
Learning curve for HTML coding skills
iPhone or other device: continual testing of published help
*According to a survey](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-18-2048.jpg)
![How to Develop Mobile Help [Contd.]
Refer this Book:
Road Ahead
Incorporate Videos or Show Me
Provide offline content
Towards Component CMS
Context-Sensitive Help
Return to TOC from each topic
Standards for Mobile Documentation
iPhone: Apple has set the guidelines](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-19-2048.jpg)
![Panel Discussion [Contd.]
Team work vs. individual contribution?
Synergy
Politics at work?
Honest
Technical writing skills for management positions?
People Management
Technical Management
Detail Oriented](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-21-2048.jpg)
![Plagiarism & Technical Writing
[Contd.]
Type of Plagiarism
• Words
• Structure
• Ideas
• Authorship
• Self
Plagiarism of Structure
• Use someone else’s logical order
• Similar structure
• Making few changes and present it](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-29-2048.jpg)
![Plagiarism & Technical Writing
[Contd.]
Consequences
Temporary leave of absence
Los of Job
Professional growth is hampered
How to Avoid
Monitoring originality in ideas and writing
Overcoming lack of awareness and seriousness of the issue
Education by Technical Writing Institutes
Journals](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-30-2048.jpg)
![Plagiarism & Technical Writing
[Contd.]
Cases of Plagiarism
Proven case of Jayson Blair
New York Times author stole 400 articles
Paid hefty fine
Esteemed Colleges (Faculty & Students) accused of plagiarism in
several instances
Copying from other journals
Not granting due credit to the mates
Copying from previously published papers
Viper – Plagiarism checking tool
Freeware
Needs Internet connection and compares articles on the Internet
Provides results with no. of matching articles and score of plagiarism
Score of up to 15-20 is allowed
Support MS Windows
Site: www.scanmyessay.com](https://image.slidesharecdn.com/learningsfrom14thstcindiaconferenceraghuramonly-130121004503-phpapp02/75/Learnings-from-14th-STC-India-Conference-31-2048.jpg)
Uploaded byRaghuram Pandurangan
Learnings from 14th STC India Conference
The 14th STC India Conference covered various topics including search optimization for help content, mobile documentation practices, and the implications of plagiarism in technical writing. Key discussions involved improving search engine rankings, creating user-friendly mobile outputs, and addressing the challenges of plagiarism in technical writing. Panel discussions highlighted qualities valued in candidates, teamwork vs. individual contributions, and the importance of both technical and people management skills.
More Related Content
Similar to Learnings from 14th STC India Conference
More from Raghuram Pandurangan
![Picture Archival and Communication System [PACS] - Overview](https://cdn.slidesharecdn.com/ss_thumbnails/picturearchivalandcommunicationsystem-overview-140111015852-phpapp01-thumbnail.jpg?width=640&height=640&fit=bounds)
Learnings from 14th STC India Conference
- 1. Learnings from 14thSTC India Conference
- 2. Agenda Demystifying Search: Makingyour help content search friendly Mobile Documentation: Create ePubs and other mobile device outputs How to Develop Mobile Help Panel Discussion – moderated by John Francisco Alfresco: An open source CMS Plagiarism & Technical Writing
- 3. Demystifying Search: Makingyour help content search friendly
- 4. Demystifying Search: Makingyour help content search friendly Why Search is important in Online Help Most help systems have a pyramid structure Provide a “Search” function Search and preferences have changed in course of time Customer used only part of phrase Customer used “Google” search to search inside Online Help Customer has the patience to click max. of four times in the “Search” – address the need.
- 5. Demystifying Search: Makingyour help content search friendly [Contd.] The Search Engine process to rank pages Crawler crawls through the pages Traffic to your page is a factor for ranking Points to remember Keywords used by as many customers does not necessarily increase the views. The low weighed keywords may be good enough
- 6. Demystifying Search: Makingyour help content search friendly [Contd.] Focus Areas in Optimization Keywords: put those keyword tags around the text Introduction: put them in the introduction of content or first page. It must not contain unnecessary information Home Page: should have cross-reference to all the pages to get better page rank. Page links: it exhibits the relative importance of pages. Do not overdo with too much links. Keywords Figure out search terms that readers might use Identify keywords (based on “Search” terms) Use those keywords in topics Remember not to use jargons irrelevant keywords unnecessary words inside the content maintain consistency (do not use synonyms or long list of words for the same term)
- 7. Demystifying Search: Makingyour help content search friendly [Contd.] Tags Search engines focus on text within special tags Introductory text of the page Page title Text inside the Hyperlink Subheadings Tag the non-textual content (Screenshots, Multimedia, Videos, etc.) with the keywords Search engines understand only text Translate the media content to words Introductory Text 30% Search Engines decide based on text in Hyperlinks 45% Search Engines decide based on first sentence
- 8. Demystifying Search: Makingyour help content search friendly [Contd.] Home Page Entry point to the key sections Place important content on Home page - with keywords in the Hyperlink text Core Tasks and Concepts Overview and high-level tasks Architecture diagrams Tutorials and Scenarios… Do not put too much links in the Home page
- 9. Demystifying Search: Makingyour help content search friendly [Contd.] Hyperlinks The topic in the search result may not be what reader was looking for. No. of hyperlinks pointing to a topic measure the importance of topic The Hyperlinks include: Regular Hyperlinks or Cross-references Tweets Every instance of “Share” page in the Social Media Network. Content Structure Remove barriers to indexing’ Make it easy for Search engines to crawl
- 10. Demystifying Search: Makingyour help content search friendly [Contd.] Search engines rank increases with: Site Map TOC and Help with hierarchy Topics with size of 300-500 words, else ignored Help architecture Internal navigation and linking is text-based No broken links No missing pages Easy navigation
- 11. Demystifying Search: Makingyour help content search friendly [Contd.] Monitor the Search Optimization is important Use Search Analytic Tools Submit Online Help URL Search terms, phrases used by Readers Topics Browsed Topics cannot be found • See the Reports in a regular basis
- 12. Mobile Documentation: CreateePubs and Other Mobile Device Outputs
- 13. Mobile Documentation: CreateePubs and other mobile device outputs Problems faced with Mobile devices Different Screen Sizes Too many document readers New user actions evolve: Touch, Tap, Swivel, Slide…. QR Codes used to scan the URL is the new trend in Industrial Help Documentation Videos can be used for Tutorials Tables Simple tables with basic text Do not Use wide table with several columns Lots of text in headings Images in table Include table as image: it works better for mobile
- 14. Mobile Documentation: CreateePubs and Other Mobile Device Outputs [Contd.] Images or Screenshots Include detailed alternate text: Speech Recognition Put the alt text in <Img> tag Tools RoboHelp : Device-sensitive content epub3: New std. output for eBook readers and mobile devices Mobi: compatible with Kindle and others
- 15. How to DevelopMobile Help
- 16. How to DevelopMobile Help Mobile Help viewer types Native applications Browser Title Important Split the mobile screen into reusable content Before You Begin How to Do See Also
- 17. How to DevelopMobile Help [Contd.] Refer this Book: Help Considerations Small screen size Simple language Concise content Primary and secondary content Use of Graphics – sparingly and wherever required only Hyperlinks Fonts Navigation techniques No. of clicks Orientation
- 18. How to DevelopMobile Help [Contd.] It is 108% tougher to read on Mobile device* Tools & Technologies for Mobile Documentation Javascript: Used for RUN applications RoboHelp: HTML output for Android and other mobile platforms Site Analytics: Adobe’s tool for seeing the usage analytics Publishing & Mapping Mobile Help using RoboHelp For browser-based Help files can be hosted in the Server The URL is called from the application on the RUN Challenges Understanding how mobile apps work Finding examples for us to read Learning curve for HTML coding skills iPhone or other device: continual testing of published help *According to a survey
- 19. How to DevelopMobile Help [Contd.] Refer this Book: Road Ahead Incorporate Videos or Show Me Provide offline content Towards Component CMS Context-Sensitive Help Return to TOC from each topic Standards for Mobile Documentation iPhone: Apple has set the guidelines
- 20. Panel Discussion Moderated byFrancisco Abedrabbo What other qualities you look for when candidate comes for interview? Asset for the company Urge to learn What you think is your success to grow in the organizations: Career Interest or Market Demand? Both Factors to shift job except for remuneration? Have a goal If not possible, move to company that gives opportunity to make it achievable. Smart work or hard work is important? Both Success or failure is important? Both: have regular gratification
- 21. Panel Discussion [Contd.] Teamwork vs. individual contribution? Synergy Politics at work? Honest Technical writing skills for management positions? People Management Technical Management Detail Oriented
- 22. : An opensource CMS
- 23. Alfresco: : Anopen source CMS Why use CMS Operational efficiency Collaboration Increased Security Drawbacks Cost Compatibility Training Alfresco Open Source Complexity Training or learning curve is less Site: http://www.alfresco.com/
- 24. Alfresco: : Anopen source CMS Alfresco Editions Cloud: 50-500 users, 104 TB Mobile: with Cloud only Enterprise: unlimited users Community: completely free, community support How to Try and Deploy 30 day free trail available Pilot project recommended before deploying Based on “Freemium” model Includes Open Source modules
- 25. Alfresco: : Anopen source CMS Components – Activiti: workflow framework – JSF: GUI – Tomcat Server – Lucene: Indexing – Apache Solr: Highlighting Content & Caching – Postgres: RDBMS/DB – Spring: Other Framework
- 26. Alfresco: : Anopen source CMS Features Dashlets Workflow: 5 Pre-defined workflow including Agile Scrum Integration with Google Docs XML, HTML Editing Social Channel Publishing Drag & Drop
- 27. Plagiarism & TechnicalWriting
- 28. Plagiarism & TechnicalWriting Plagiarism: derived from the Latin word, meaning “kidnap” General causes of plagiarism Unintentional Not giving the due credit to the author Causes Lack of subject knowledge Inexperience Lack of time or deadline pressure Laziness Writer block syndrome Didn't thought about being caught Carelessness Lack of Creativity
- 29. Plagiarism & TechnicalWriting [Contd.] Type of Plagiarism • Words • Structure • Ideas • Authorship • Self Plagiarism of Structure • Use someone else’s logical order • Similar structure • Making few changes and present it
- 30. Plagiarism & TechnicalWriting [Contd.] Consequences Temporary leave of absence Los of Job Professional growth is hampered How to Avoid Monitoring originality in ideas and writing Overcoming lack of awareness and seriousness of the issue Education by Technical Writing Institutes Journals
- 31. Plagiarism & TechnicalWriting [Contd.] Cases of Plagiarism Proven case of Jayson Blair New York Times author stole 400 articles Paid hefty fine Esteemed Colleges (Faculty & Students) accused of plagiarism in several instances Copying from other journals Not granting due credit to the mates Copying from previously published papers Viper – Plagiarism checking tool Freeware Needs Internet connection and compares articles on the Internet Provides results with no. of matching articles and score of plagiarism Score of up to 15-20 is allowed Support MS Windows Site: www.scanmyessay.com
- 32. Credits Speakers at the14th STC India Conference, Bangalore Cartoons and Images from: Flickr.com, www.fastcompany.com canstockphoto.com thejparkergroup.com www.neatnet.co.uk 123rf.com Facebook.com Francisco photo from his Facebook profile Alfresco logo from Alfresco
- 33.
Editor's Notes
- #30 Structure is the most prone to plagiarism