Have you struggled with job position names and titles in your policies and procedures (P&P) content? Here are several style rules to follow. Read article.
Entries Tagged as 'Procedures'
Style Rules for Job Position Names and Titles in Policies & Procedures
October 24th, 2009 · Comments Off · Technical Writing
Do Technical Writing projects need a Documentation Plan?
October 17th, 2009 · View Comments · How To, Technical Writing
Gordon McLean asks: do you plan to review your plan? This is in relation to the Documentation Plan (aka Information Development Plan) that most technical writers prepare in advance of starting a major project. Granted, on smaller projects you can get away with this if you know the product, have the resources and the deliverables [...]
Tags:Audience·authoring software·Business·Business Services·communication·Content·data repository·Deliverables·Documentation Plan·Gordon McLean·Information Development·Master Document List·Mobile device·Online Help·planning·PMP·Procedures·Project Plans·project stakeholders·revising documents·Sarbanes Oxley·software requirements·status reports·Technical·technical writer·Writer requirements·Writing and Editing
Adobe FrameMaker 9.0.3 Released & Features that SHOULD Work
October 14th, 2009 · Comments Off · Technical Writing
You can now download the FrameMaker 9.0.3 patch. Mahesh (http://blogs.adobe.com/techcomm over on Adobe does a great job of keeping us up to date with all things FrameMaker. This is available through Adobe Update Manager (AUM). This patch (9.0p250) must be applied on top of 9.0.2 (9.0p237) only. You can check for updates through Help->Updates Menu [...]
Tags:903·Adobe Captivate·Adobe Framemaker·Adobe FrameMaker·Adobe Framemaker 9·Adobe Technical Communication Suite·API·Audience·Chunking·CMS·Conditional text·Conref·content management·Content reference·Content references·cross-reference·Darwin Information Typing Architecture·Data Formats·Data Management·Dita·DITA Open Toolkit·DocBook·DPI·ibm·Long Documents·maps.·Metadata·MIF·Modular·Nested Tables·Patch·PDF·platform·Policies·Procedures·Publishing·Robohelp·Standard Generalized Markup Language·STC·Strategy·Structure Authoring·Styling content·Table Designer·technical communication·technical communicators·Technical documentation·Technical Publications·Technical Writing Software·Tekom·Topics·User Variables·WebDav·XML·XML authoring
Top 50 Technical Writers on the Web
October 1st, 2009 · View Comments · Career
I’ve made a list of the top 50 technical writers with a web presence. Some of these you might know, such as Darren Barefoot and Tom Johnson. I have also added some other writers from India, Russia and Israel to reach out to a wider audience. I’m sure there are others that I’ve missed. Let me know and I’ll update the list.
Tags:Adobe FrameMaker·Audience·Chunking·Conditional text·content management·Content reference·Content references·Darren Barefoot·Data Management·Dita·ibm·India·Ireland·israel·maps.·Metadata·Modular·platform·Policies·Procedures·Russia·Strategy·Styling content·Technical Publications·Technical Writers·Tom Johnson·Top 50·Topics·XML
Twitter Updates for 2009-06-23
June 23rd, 2009 · Comments Off · Technical Writing
Review of Groundswell – Social Media Technologies Forrester Research http://bit.ly/Lsol9 # RT @StanChu Facebook Developer Garage Shanghai June 27 http://bit.ly/B3rzD # YAK WordPress open source shopping cart. Developed by SourceForge http://ping.fm/w502b # Stunning Twitter Timeline – Evolution of Twitter in the last 3 years http://bit.ly/rxe2r # Google Insights. Web Search Volume for Social Media http://ping.fm/YRPDB [...]
Tags:Adobe FrameMaker·Audience·Chunking·Conditional text·content management·Content reference·Content references·Data Management·Dita·ibm·maps.·Metadata·Modular·platform·Policies·Procedures·Strategy·Styling content·Technical Publications·Topics·XML
DITA specialization in Adobe FrameMaker 9
June 22nd, 2009 · Comments Off · Technical Writing
DITA Specialization lets you define new information classifications that can be structural or a new domain specification. Structural specialization in DITA lets you define new topic or map structures derived from base topics and maps, such as concept, task, or reference whereas domain specialization in DITA lets you define markup for a specific information domain or subject area, such as programming or hardware.
Tags:Adobe·Adobe Acrobat·Adobe Captivate·Adobe Framemaker·Adobe FrameMaker·Adobe Reader·Adobe Technical Communication Suite·Audience·Chunking·Conditional text·content management·Content reference·Content references·Data Management·Digital·digital publishing·Dita·DITA Open Toolkit·eBooks·ibm·Long Documents·maps.·Metadata·Modular·platform·Policies·Procedures·RIA·Robohelp·Strategy·Styling content·technical communicators·Technical documentation·Technical Publications·Topics·XML
Speedlinking – FAQs about the Darwin Information Typing Architecture (DITA) Part 2
June 16th, 2009 · Comments Off · How To
Speedlinking – FAQs about the Darwin Information Typing Architecture (DITA) Part 2
Tags:Adobe FrameMaker·Audience·Chunking·Conditional text·content management·Content reference·Content references·Darwin Information Typing Architecture·Data Management·Dita·FAQs·ibm·maps.·Metadata·Modular·platform·Policies·Procedures·Speedlinking·Strategy·Styling content·Technical Publications·Topics·XML
Speedlinking – Darwin Information Typing Architecture (DITA)
June 12th, 2009 · Comments Off · How To
10 Sites about Darwin Information Typing Architecture (DITA)
Tags:Adobe FrameMaker·Audience·Chunking·Conditional text·content management·Content reference·Content references·Data Management·Dita·ibm·maps.·Metadata·Modular·platform·Policies·Procedures·Strategy·Structured Authoring·Styling content·Technical Publications·Topics·XML
Review EPIC Editor – XML and DITA Authoring Software
June 9th, 2009 · View Comments · How To
Of all the technical writing tools I’ve used over the years, Epic Editor was probably the most impressive, especially when it came to doing tech documents that involved DocBook and Dita. It was difficult to learn – no point pretending otherwise – but once I got the hang of it, I used it non-stop for [...]
Tags:Adobe FrameMaker·Audience·Authoring·Chunking·Conditional text·content management·Content reference·Content references·Data Management·Dita·DocBook·Editor·EPIC·ibm·maps.·Metadata·Modular·platform·Policies·Procedures·Review·Strategy·Styling content·Technical Publications·Topics·XML
Most Technical Writers to work in Structured Authoring environment by 2010
June 9th, 2009 · View Comments · How To
In a recent survey, Scriptorium Publishing found that a majority of technical writers will be working in a structured authoring environment by 2010.
Tags:Adobe FrameMaker·Audience·Authoring·Chunking·Conditional text·content management·Content reference·Content references·Data Management·Dita·ibm·maps.·Metadata·Modular·platform·Policies·Procedures·Publishing·Scriptorium·Strategy·structured·Styling content·Survey·Technical Publications·Technical Writers·Topics·XML
WEBINAR: Learning to Love Structured Authoring
June 8th, 2009 · Comments Off · How To
Emma Hamerm, Senior Consultant at eHamer Associates Ltd, looks at the common fears around moving from unstructured to structured content, (and needing to learn about DITA and XML – which frightens many people more than they’ll admit to). Emma will explore some similes and metaphors that will help us understand the impact of these new [...]
Tags:Adobe FrameMaker·Audience·Chunking·Conditional text·content management·Content reference·Content references·Data Management·Dita·ibm·maps.·Metadata·Modular·platform·Policies·Procedures·Strategy·Styling content·Technical Publications·Topics·XML
Free version of Serna XML editor for Technical Writers
June 7th, 2009 · Comments Off · How To
Syntext has released a free edition of its Serna XML editor. This is designed for technical writers who work with DITA, DocBook and other common XML formats.
Tags:Adobe FrameMaker·Audience·Chunking·Conditional text·content management·Content reference·Content references·Data Management·Dita·DocBook·ibm·maps.·Metadata·Modular·platform·Policies·Procedures·Strategy·Styling content·Technical Publications·technical writer·Technical Writing Software·Topics·XML·XML editor
Follow Friday – News and Views June 3
June 4th, 2009 · View Comments · How To
Follow Friday – News and Views June 3rd 2009. Here’s a roundup of some of this week’s news. Next week, I’ll add more info on upcoming XML authoring software releases and the new Google Wave platform.
Tags:Adobe FrameMaker·Audience·Camtasia·Chunking·CMS·Conditional text·content management·Content reference·Content references·Data Management·Dita·google·groundswell·Hulu·ibm·India·Jing·maps.·Metadata·microsoft·Modular·platform·Policies·Procedures·Release Notes·Review·Snagit·Strategy·Styling content·Technical Publications·Topics·Webinar·XML
FREE WEBINAR: Increase Publishing Efficiency from Author to Customer
May 31st, 2009 · Comments Off · How To
Mark Poston, Senior Technical Consultant, at Mekon Ltd, describes how deploying DITA tools is not only possible, but can greatly improve the efficiency of your business. For years organizations have wanted to get Subject Matter Experts (SMEs) creating Business Documentation in XML so it can be single-sourced and reused in various scenarios. DITA XML has [...]
Tags:Adobe FrameMaker·Audience·case studies·Chunking·CMS·Conditional text·content management·Content reference·Content references·Data Management·Dita·ibm·maps.·Metadata·Modular·platform·Policies·Procedures·Strategy·Styling content·Technical Publications·Technical Writing·Topics·XML
White Paper – Technical Communication industry Adopting XML
May 29th, 2009 · Comments Off · How To
A recent survey by Scriptorium Publishing found that most technical writers will be working in a structured authoring environment by 2010. Structured authoring is a publishing workflow that defines and automatically enforces consistent organization of information. Implementations are generally based on Extensible Markup Language (XML).
Tags:Adobe FrameMaker·Audience·Chunking·CMS·Conditional text·content management·Content reference·Content references·Data Management·Dita·ibm·maps.·Metadata·Modular·platform·Policies·Procedures·Strategy·Styling content·Technical Publications·Technical Writing·Topics·XML
