TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Got a simple system to track system text? From:reshma pendse <reshma_pendse -at- yahoo -dot- co -dot- in> To:Sarah Lee Hauslinger <slhauslinger -at- gmail -dot- com>, Steve Schwarzman <steve -at- writersbookmall -dot- com> Date:Fri, 9 Mar 2012 16:54:15 +0800 (SGT)
You could also use a DB-based utility which your developers should be able to rig up. Basically, create a Database for all your UI text and messages, with a primary ID/message ID, message text, status, and any other columns you need. Create a basic interface where you can view and edit the text. WHen you save, changes are saved to the DB. You can add an option to generate a .xml or .message file that the developers can then import into their code. this can even be automated.
We used a utility like this in my previous company, and it worked beautifully! We even tracked all the windows where that text ID was used, if it was erro text, then we could capture all the scenarios where it was used...You need not go that far!
________________________________
From: Sarah Lee Hauslinger <slhauslinger -at- gmail -dot- com>
To: Steve Schwarzman <steve -at- writersbookmall -dot- com>
Cc: techwr-l -at- lists -dot- techwr-l -dot- com
Sent: Friday, 9 March 2012 2:46 AM
Subject: Re: Got a simple system to track system text?
On Thu, Mar 8, 2012 at 9:12 AM, Steve Schwarzman
<steve -at- writersbookmall -dot- com> wrote:
> I'm looking for a not-overly-complicated system to manage the tracking of
> system messages and screen text for an app.
>
> It's not a CMS - that is, I'm not going to update the app directly from
> this tracking system. It's a tracking system for each piece of text so that
> developers can see what edits are needed and which ones haven't been done
> yet. It will also serve as a master for all the texts.
>
> Suggestions better than a spreadsheet?
How about using the issue-tracking system? That's how my team handles
it. R&D uses the system to track all development work, both bugs and
new features/improvements. We also use it to track, plan, and schedule
updated and new docs. Our developers and engineers often get busy
enough that they don't notice emails or wiki pages, but pay close
attention to issue tickets. We've developed a system of filters,
special ticket types, and custom component and field settings to
ensure that we catch everything that needs documenting. For us, it's a
highly effective strategy.
Sarah Lee Hauslinger
slhauslinger -at- gmail -dot- com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com
Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help. Choose your authoring formats and get any output you may need.
Try Doc-To-Help, now with MS SharePoint integration, free for 30-days.
