Wiki-Based Authoring & Publishing

Views:
 
     
 

Presentation Description

Wiki-based collaborative authoring and publishing is a realistic and achievable goal. The business case for making such a transition is also compelling. This presentation describes a software documentation group’s transition from a highly optimized FrameMaker and WebWorks Publisher-based publishing process to a Wiki-based replacement. It goes through the steps the group took to arrive at their solutions and lists the sources they used to learn about their options.

Comments

Presentation Transcript

Printed Books and Online Help Using a Wiki : 

Rahul Mehrotra STC Technical Communication Summit Philadelphia, Pennsylvania, USA Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books and Online Help Using a Wiki • Collaborate • Create • Moderate • Publish • Manage

Eye of the Needle : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Eye of the Needle

Barrier for Entry : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Barrier for Entry

Need to Focus : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Need to Focus Alan’s Chart

Managing Churn : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Managing Churn

Hunting for the Wiki : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Hunting for the Wiki

Down the Rabbit Hole : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Down the Rabbit Hole http://www.dmoz.org/Computers/Software/Groupware/Wiki/Wiki_Engines/

The Matrix : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra The Matrix http://www.wikimatrix.org/

Contenders : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Contenders

The One : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra The One http://www.atlassian.com/software/confluence/

Moving the Mountain : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Moving the Mountain Greg’s Scripts

Cleaning-up : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Cleaning-up

Single-Sourcing : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Single-Sourcing

Theme Building : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Theme Building http://confluence.atlassian.com/display/CONFEXT/Theme+Builder

Privilege and Access : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Privilege and Access

Rollout : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Rollout

Content and Process : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Content and Process COLLABORATE

Add or Modify : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Add or Modify Add • Edit • Copy • Remove COLLABORATE

Rich Text or Markup : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Rich Text or Markup CREATE

Images and Equations : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Images and Equations Create • Attach • Insert CREATE

On Moderation : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra On Moderation catch-validate-edit-publish

Spotting Change : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Spotting Change MODERATE

Content Integrity : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Content Integrity MANAGE

Version Control : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Version Control MANAGE

Workflow : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Workflow

Place and Publish : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Place and Publish catch-validate-edit-publish Carol’s List PUBLISH

Web (Wiki) : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Web (Wiki)

Online Help (.html) : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Online Help (.html)

Windows Help (.chm) : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Windows Help (.chm)

Books (.pdf) : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Books (.pdf)

Collaboration : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Collaboration

Results : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Results Project collaborative authoring unobtrusive moderation on-demand publishing Business increased capacity faster turnaround low cost easy-to-use end-to-end solution User experience quality responsiveness Collaborative Authoring | Unobtrusive Moderation End-to-End Solution | Quality | Responsiveness On-Demand Publishing | Increased Capacity | Faster Turnaround | Low Cost | Easy-to-Use “Now that I've moved to [ADS] 2008 version the help is greatly improved. Thanks, its a big step forward over previous version.” -Customer survey feedback 5/7/08

To Do : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra To Do Automated Export Multi-Language Support Equation Editing Workflow Control Publishing Control Logical TOC Generation Color-Coded Code Conditional Content (Text and Images) "I said it in Hebrew--I said it in Dutch--I said it in German and Greek:But I wholly forgot (and it vexes me much)That English is what you speak!"

Done : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Done http://www.agilent.com/find/eesof-docs

Thanks! : 

STC Technical Communication Summit • Philadelphia, Pennsylvania, USA • Wednesday 4 June 2008 1:30-2:30 (Room: 109B) Printed Books & Online Help Using a Wiki • Rahul Mehrotra Thanks! Questions… Comments…