October 12, 2017

The Future of Technical Communications

The future of Technical Communications – Findings from Adobe Tech Comm. Survey





Are you eager to know the future of technical writing?

You may have your own reasons to explore. Information Developers Conclave- 2017 keynote presentation will help you to find the correct answer with correct data and facts.

You want to foray into technical writing, or you want to transform your career of technical communication by gaging at future and can learn a new skill.

Amitoj Singh Product Manager Adobe Technical Communication will help you to answer all your quires about the future of technical writing in India and globe. 

You can take a well-defined career path just after the session of Amitoj Singh.

Information Developers Foundation will help you to reskill to become more valuable assets of your organization.

Session details: 

This session will cover trends and findings from Adobe Tech Communication Survey and how the information developer/technical writer industry has been evolving. 

This session will share insights on  questions such as “Is XML/DITA the future of authoring ” , 
“Which publishing formats are gaining tractions”?

 “Are trends different across Asia , Europe and North America”, “is there specific trends across industry verticals” , etc?

Speaker Bio:

Amitoj Singh, Product Manager – Adobe Technical Communications Tools (FrameMaker and RoboHelp)
 
A business technocrat with more than 10 years of experience in software industry. Started his career as a software engineer with Adobe in 2005 and been in Product Management space for last 7+ years..


Apart from the session of Amitoj, IDF Conclave also brings 

3 Keynotes
2 Workshop from Adobe 
14 Presentation
1 Panel discussion

just at the half rate of other conferences. Still, you want the discount to write to us.


October 8, 2017

Adobe at IDC Annual Conference-2017


Save the Date for the Adobe Tech Comm Certification Workshop at IDC Technical Communication Conclave-2017


Information Developers Foundation is excited to announce first of its kind workshop at the Information Developers Conclave 2017.



adobe

1-2-3’s of Adobe FrameMaker 2017 and how to speed up authoring for unstructured and xml content.


In this workshop conducted by Adobe Solution Consultant Bharat Prakash, the session will touch on ideas that every writer, template developer, and user of FrameMaker should be aware of. Tips for accelerating the creation of content, templates, using paragraph and character designer functions, and the things that "just should work" are addressed and explored. This session will also showcase how FrameMaker 2017 can be used to create DITA or any XML content swiftly and do multichannel publishing.


Bharat Prakash Brief  Bio: 


Bharat Prakash is the Solutions Consultant for the Technical Communication unit at Adobe and has more than a decade’s experience in software development, testing and consulting. Bharat is an expert in Structured Authoring and various industry standards like DITA and MathML.

Delivering immersive user experiences with Adobe RoboHelp 2017!-Manminder Singh, Adobe


In this workshop, Manminder Singh, Adobe's Product Solution Consultant, will take you on a tour of topic-based authoring with Adobe RoboHelp 2017 release. The workshop will focus on how you can author, enrich, publish and deliver immersive Help content experiences to all the user. Manminder will showcase how to deliver Google like search experience, bookmark favorite topics, and find relevant content faster using Dynamic Content Filters.

Authors can now increase their productivity by using the modern ribbon based UI, build frameless HTML5 layouts and deliver next-generation navigation experience to the end users.

Manminder Singh Brief Bio: 


Manminder Singh is the Product Solutions Consultant for Adobe Technical Communication and E-Learning line of products. He has been working with Adobe for more than 4 years and specializes in Adobe RoboHelp, RoboHelp Server and Adobe Captivate.  Manminder is an expert in providing solutions to the clients and also guides them through the best practices to create and deliver content using the right tools.

Do you want to know about: 


The future of Technical Communications – Findings from Adobe Tech Comm. Survey-Amitoj Singh, Product Manager – Adobe 

Wait for our next blog.

Attendees of the workshop will get participation certification from adobe.

September 22, 2017

Brief review of internal developer documentation style guide

                                  

Developer documentation Style Guide

In this blog post is for technical writers involved in writing internal developer documentations. In this, you will learn brief comparison of different style guides (Google, Atlassian, and SalesForce).

Style guide for technical writing It’s the first thing a newcomer needs to study to understand and track the changes in a project. A bad documentation is worse than no documentation at all. 

Many companies have their own internal developer documentation style guide to write documentation error-free and absolutely clear to prevent any kind of ambiguity but, when they come across external contributors it becomes tough to understand and change the style guide into its own format.

Google is releasing its internal developer documentation style guide. This can quite literally guide your documentation, giving you a great starting point and keeping things consistent.

If you want to follow Google's style guide for your project, you can simply access it here.

In order to better support external contributors to open source projects such as Kubernets, Amp, or Dart, recently Google has released its own internal documentation style guide.

The documentation style guide of Google can be useful for general issues like reminders to use second person, present tense, active voice, and the serial comma. They have also listed a few things to avoid while documentation.

  •        Being too cutesy
  • .      Placeholder phrases like ‘please note’
  • .      Choppy or long-winded sentences
  • .      Starting all sentences with the same phrase
  • .      Current pop-culture references
  • .      Jokes at the expense of customers, competitors or anyone else.
  • .  

Few more such as Atlassian, WordPress, and Salesforce also released their internal style guide to optimize consistency across developer documentation. 

A glimpse of highlights of these style guides is given here to make documentation an easy and accessible task for the newcomers and external contributors. 

Style guide for Atlassian developer documentation

·        Ensure a DOCS: maximum image width of 700 pixels.
·        Use the DOCS: theme colors for sophisticated effects.
·        Include the DOCS: product version to which your update is relevant. Use 'Available', 'Changed' and 'Deprecated'.
·        Use plenty of DOCS: code samples.
·        Make use of our DOCS: templates.
·        Mark all drafts clearly as DOCS: work in progress.
·        Do not DOCS: delete, move or rename any page that you did not create yourself.
·        Use DOCS: internal link format rather than the full [http://xxxx] external link format.
·        Be aware that the content of some pages is DOCS: reused in other pages. Make sure you put your content in the right place. This applies in particular to the Atlassian Plugin Framework documentation.

·        Maintain a DOCS: consistent style, layout, grammar and format with the rest of the page or space.
·        Use Australian DOCS: spelling. For example, use 'organisation' not organization. Use 'customising' not customizing.
·        Use title case for DOCS: headings, not sentence case. For example, 'This is a Heading'.
For complete guide visit https://developer.atlassian.com/about/style-guide-for-the-atlassian-developer-documentation

Few points from WordPress documentation style guide:

1.      Include screenshots
2.      Theme name and menu items are italicized
3.      Use title case for section titles
4.      Spell out numbers nine and under
5.      Use US spelling and punctuation conventions
6.      Refer to the dashboard, not the admin area
7.      Don’t number your section  heading
8.      For complete guide visit https://developer.wordpress.com/themes/documentation-style-guide/

Salesforce’s guide has the following sections:
·        Styles A-Z–Alphabetical reference of basic guidelines for grammar and usage for documentation and user interface text.
·        Glossary–Definitions and usage of Salesforce terms and other key user interface terms.
  • For complete guide visit https://developer.salesforce.com/docs/atlas.en-us.salesforce_pubs_style_guide.meta/salesforce_pubs_style_guide/overview.htm






September 11, 2017

IDF girds up its loins for the upcoming Conclave with the theme “transformation"

Largest Conference of Content professionals



Information Developers Foundation, the first and largest Indian technical communicators society and a not for profit organization is proud to announce its grand two daylong conclave to be held on 10th-11th November 2017

IDF is hosting a mega event wherein inputs are given by the speakers from pan India. This event is going to witness 100+ technical communicators such as technical writers, content writers, structural designers and persona from the similar profession. The theme of this conference is – transformation (skill, technology, and career).  The speakers possess decades of experience and expertise in their respective domain. This grand event is going to be held in the luxurious ambiance of The Hotel Suryaa -New Delhi.

Through this event, IDF plans to provide an interactive session wherein technical communicators of different expertise and experience share their knowledge and provide the audience a deep insight into the newest technology and advancement in this sector. 

The current skill sets required, new technology and the job opportunities will be discussed. This conference will enhance one’s perspective towards their career and a better understanding on how to excel in this field.  Our speakers are notable personalities who have achieved excellence and have a good screen presence wherever they stand to deliver their mind out. 

To mention a few speakers are- 
Mr. K Narssimhan (Founder and CEO Commit Technologies Pvt Ltd), 
Mr. Bipul Keshri (Director, Usability and Design, Global logic), 
Mr. Amit Kapoor (Associate Director, content- Cigniti Technologies), 
Mr. Raghuram Pandurangan (Documentation Chapter Leader in Causeway), 
Dr. Anu Singh (Manager at Fiserv), Mr. Ankur Srivastava (Manager - NXP Semiconductors), 
Mr. Rahul Prabhakar (Influencer and a Blogger), 
Ms. Pooja Gandhi (Learning Products Manager at Agilent Technologies), 
Ms. Madhumita Sharma (Program Manager at Gemalto),
Mr. Sagar Garuda (Manager - Content at Zenoti)
Ms. Roli Sinha (Consultant at Cadence). 

This list doesn’t end here because we have keynote speakers, panel discussions, quick bites, etc. and workshops by our title sponsor Adobe. The topic to be discussed here are related to transformation in skill, career, and technology such as “Zen and the art of technical writing”, “Role and importance of UX in Information Architect”, “Information Development-Technique, Perspective and you”, “SaaS Documentation- the future is now”, “The Metamorphosis required in the world of writing”, “Technical writing in current Global Trends”, “How social media can be part of your set of TechComm skills”, “ How to transform your career” and many more.

This two-day long content professional conference is fully dedicated to ensure that all the tech communicators of India grow their network and form a society to be mutually benefitted by multidirectional exchange of knowledge. More information about the Conclave can be seen on www.informationdevelopers.in



September 8, 2017

INFORMATION DEVELOPERS FOUNDATION -A REVOLUTION

              
The caption- Revolution is apt for the newly founded “Information Developers Foundation” (IDF) for many reasons. Before discussing the reasons lets go back and see the present scenario of professionals who are into technical communication, though it is technical writers, content writers, structural designers or similar occupation. In spite of the fact of being an important pillar of the IT industry, this sector is not organised as it should be. They don’t have a proper community or a platform where they can meet, discuss, and evolve as a better professional by exchange of knowledge. A few years back most of us didn’t even know about this job opportunity prevailing in IT sector. IT industry was known to be a hub of engineers only. There was least recognition of information developers in our country, unlike some developed countries who have their own technical societies. Why India lacks such platform? To answer this question IDF came into existence- to establish Information Development as a profession.
                         IDF is a not for profit organisation that focuses on to provide this education accessible and affordable to everyone. They train and upgrade the skills of information developers. They don’t stick to the conventional method of teaching, instead, they include different mode of learning in their curriculum such as classroom classes, online sessions, events, conferences and webinars, to make learning more interactive, engaging and evolving. IDF also provides a learning platform to exchange knowledge in various disciplines across the globe.

                                         There might be a question in one’s mind- Why IDF? To clear all the doubts there is only one answer, its experience. Information Developers Foundation was previously contributing to the society as ADID (ApraDocs Information Developers) and has earned a significant recognition in North India among the various organisations. They were into training with a record-breaking placement of 100%. Years of experience and active participation in most of the tech events have enriched them with a good database and an excellent network. They have a mission now, to organise and promote information developers in our country. They are also looking forward to boosting up this sector by accreditation and certification that would be valid pan India, ensuring that this certification guarantees the skill set of certified personnel. This will also add value to the resume of a prospective candidate. They are organising regular webinars to give more insight on the new developments and methodology in technical communication. One of their upcoming conference in November is going to witness hundreds of tech-communicators from across the globe, eminent speakers who are going to give deep insight and a multi-directional approach to this field. This is a great opportunity for the tech communicators as this mega-event will give them an excellent network and knowledge that will help them to grow as a better professional and also enhance their career aspects. For more details kindly visit www.informationdevelopers.in

August 31, 2017

Buy Ticket of Information Developers Foundation Conclave-2017


Information Developers Conclave Speakers

August 29, 2017

Technical Writers at Singapore

TechComm meet at Singapore


Gemalto always believe documentation is an important part of the delivery and at Gemalto techpub team strives to deliver intelligent content and on time. To discuss content strategy Gemalto Information Developers meet in Singapore and it was truly fun.

The team from the different part of world Israel, India, Singapore, Canada and US flock to meet and share.

After the hectic meeting in the evening, we use to go out to explore the beauty and marvel of Singapore and it was truely amazing.

I experiment a lot with the foods. In the little India (Small area name little India) the varieties of south Indian cuisine was much more than Delhi.

If you want to eat authentic Indian cuisine Annapurna is a must visit as this restaurant is run by a charitable trust you can pay as per your wish. Food, service, and mission of the restaurant is excellent.

I was little disappointed by night safari. rest everything was out of the world.

Wish one-day Information Developers Foundation can do a meet up of technical writers in Singapore.


Few Singapore marvel:










August 22, 2017

TechComm Webinar Channel


IDF TechComm Webinar Channel



Every Saturday 10;00-10:40 PM (IST).Do not miss your favorite program 

                                  IDF TechComm Webinar 


Inline image 1

Inline image 2


Do not forget to attend the IDF Conclave of New Delhi

Regards,
Team IDF
We are enabler, not disruptive

August 15, 2017

IDF- Proud to be an Indian

15 August- Happy Independence Day



Information Developers Foundation is a first Indian nonprofit organization working for the information developers. Proud to be an Indian.

Information wants to be free.

August 14, 2017

Technical communicators regional conference -New Delhi 2017


From the page of a diary-2017




12/08/2017 It was a great gathering of technical communicators in Gurgaon. Good to see the delegates fly from Hyderabad, Bangalore, and Ahmadabad to listen to the eminent speakers. Most of the delegates were senior level, it would have great if the younger generation would have participated as well.
Two young speakers were truly impressive Rinni Mahajan and Padma Swaroop Mandapaka. You guys are the future.

Out of the box session from Minakshi, and marketing communication from Piyush (Spice digital) was very informative. Rajiv's talk on the management of the virtual team was great in such a short span of time. Inputs from the audience like from  Rahul, Hemant Mishra, and Meenakshi made this event more interesting.

Thanks to Manisha for taking the pain to organize this.




Participants at Delhi-NCR  Regional Conference. 



I strongly feel only Bangalore should not have all the fun New Delhi deserve too.

Looking at the delegates I am confident about the upcoming event  Information Developers Conclave- New Delhi is going to be well received.

Few days are left only for the last date of sponsoring the event and speaker's proposal that is almost about to finish. Few speakers proposal are so compelling that our event committee decided to confirm them without any delay.

You will listen to the details very soon. Stay tuned.

Do not forget to like us for the latest information on the Information Developers Foundation initiatives.

http://informationdevelopers.in/community/





August 7, 2017

IDF Conclave introduction



Information Developers Foundation first conclave introduction video


Infomation Developers Foundation (IDF) is registered under the Section-8 of Companies Act 2013. IDF intends to promote art,  science, research, social welfare, etc of Information Developers. The main object of IDF to ensure the promotion of technical communication fields.







July 17, 2017

Ticket of IDC-2017, New Delhi


Information Developers Conclave-2017 

New Delhi - INDIA

The Suryaa Hotel 

11- November-2017


IDC-2017 Venue


IDC-2017 is a must visit event for all the technical writers and the professionals working in the similar fields.
This event will host esteemed speakers to share the knowledge with the well-informed delegates.

IDC event champions are working tirelessly to make this event a must remember event in the history of technical writing

If you want to sponsor our event or want to be speaker contact us without wasting a time.Probably you can be late.

Grab your super early bird ticket now. For more details call me 7840841999.#idf2017
This is an Information Developers Foundation Initiative.
For detail visit our website- Information Developers Conclave-2017

June 21, 2017

5 best ways to provide writing samples


Producing technical writing sample during interview


During the interview, it is very common when the interviewer asks for the writing sample, this happens with all of us. So, what to do in that case?

No silver bullet but we can take few approach.

Why they want it and what is stopping you from doing that?

Why they want it?



  1. Want to see your writing style and skill
  2. Grammer proficiency
  3. Tool used by you
  4. Domain you worked
  5. Style guide knowledge
  6. Continue....



What is stopping you?


You may not have it- You never carry anything from office hardcopy or softcopy. Good job this is expected from you.


  1. If you are not violating confidentiality, the security or any legal issue you can carry and distribute all depend on nature of the document.So when you are producing anything from your past job make sure you are violating any legal issue. Your perspective employer will understand this.
  2. You can also create documents that look and speak exactly the same as the ones with sensitive information, but change the names and identities of the topics.
  3. A next approach could be to invest some time researching the company you are applying to and use any information you can to create something "for" them. Who knows, they may hire you on the spot!
  4. For 'public' profiles, take a screenshot of one page (UG) or one topic (help system) that illustrates your work. get permission from the client to do this, but, in general, use an older version of the documentation, not the most recent version.You can also, use a photo editor to remove any product-identifying, company-identifying, or proprietary information... like product names or feature names specific enough to a product to identify the company.
  5. If you can't use any of your previous work, you could create some sample documentation for FrameMaker, Word, or RoboHelp since you're already familiar with these tools.
Good Luck! Want to read your story, write in comment box.


June 4, 2017

Problem of open source- clear documentation



Importance of good document


Documentation is the key to success of any software programming, in the IT industry and most of the company understand the importance of the good document. Companies have their own internal documentation style guides but, at some point of time, they also have to look at the open source documentation for the different project needs. With the open source, documentation comes many challenges hand to hand that can hamper the sole purpose of software engineering. Those challenges need to be discussed so that the documentation can become error-free and in its right spirit.


Image courtesy: thenextweb


·        Incomplete and confusing documentation is the most common challenge to be faced when the input is open source. This is because of many reasons. To list a few are:

Documenting is not a general writing, it needs a set of skills and ability to understand and document accordingly as per the need of any project. In an open source documentation most of the time the skills are not up to the mark and hence the writer lacks the ability to document all the work properly.
Any documentation needs to be completed in a particular time frame and in order to meet the deadline often the perfection is not achieved.

Any software has a tendency to change and the documentation needs to be changed accordingly, which tempts a writer to wait until the software change is finalized and after that, they are left with minimal time to complete the documentation.

·        The second major challenge is unresponsiveness. This may be because of perceived focus on the developer. The user can be the right person to do the documentation but when the documentation revolves around the developer the writer is less interested to contribute from their side and the unresponsiveness from the user effects the quality of documentation.

·        It is also very necessary to take a contribution from the users who are not well informed because as an end user they value the documentation the most. They can contribute to have a clear and accessible language in the documentation as they are not preoccupied with the project and developers thought.

·        Some more small challenges to be faced are such as unwelcoming language and content, unexplained rejection etc.



January 5, 2017

Technical writing highest paying jobs in India in 2017


What a good news in the starting of the year 2017.

Technical writing in the highest paying jobs in India claims Economics Times.

Excerpt from the Newspaper

Technical writer
2 Jan, 2017
Technical writer
While writers and content writers are one thing, technical writers are completely different. They also write but their focus is mostly on technicalities related to an IT firm or programming company. For companies specializing in technology like Adobe, Oracle, and similar brands, a technical writer is must.

Minimum Qualification: Graduate

Salary range: Rs 50,000 to Rs 1.7 lakh a month

To read more click here.