Re: content structure/strategy

Subject: Re: content structure/strategy
From: sharipunyon -at- gmail -dot- com
To: jopakent -at- gmail -dot- com
Date: Thu, 30 Nov 2017 16:00:06 -0500

Try to focus on the purpose of the software, and the need for a workflow and how it will be used.

Then refocus the documentation on tasks. That way if a button position or name changes it isnât such a big deal. And it reminds the engineers that they are creating a real product that people will use, not just participating in a circle jerk. Oh, and read up on agile terminology so you sound good.

> On Nov 30, 2017, at 2:17 PM, <jopakent -at- gmail -dot- com> <jopakent -at- gmail -dot- com> wrote:
>
> I'm on a team that is changing our software release cycle. We've currently
> producing TBA content in guides that are very UI focused, along with online
> help that is completely focused on the UI. The issue in the past has been
> that the dev teams we support make last minute changes to the UI and
> TechComm misses it. Then we end up scrambling to make last minute revisions
> before release.
>
>
>
> With the new software release cycle, we're no longer tracking progress by
> the same milestones used in previous releases. I.e. - there's no planning
> complete dates, no code complete dates, no test complete dates, etc.
> Instead, the expectation is that teams will develop in an iterative manner.
> To adapt to this new approach to development, we've been asked to approach
> documentation in a way that isn't too tightly coupled to the UI.
>
>
>
> My "sky is falling" response is to envision trying to describe how to
> perform new tasks while having to avoid referring to the controls you need
> to use to complete those tasks.. To say the least, I'm not feeling very
> optimistic. Before I report that in today's brainstorming session, it
> occurred to me that I can't be the first one trying to deal with this
> scenario. It seems like some kind of content structure/strategy solution is
> going to be at least part of what we're going to need to change, and, well,
> structure and strategy are not exactly my strong suits.
>
>
>
> TIA,
>
> JPK
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as sharipunyon -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and info.
>
> 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

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


Follow-Ups:

References:
content structure/strategy: From: jopakent

Previous by Author: Re: Using "Fences" as File Management Tool?
Next by Author: Re: content structure/strategy
Previous by Thread: Re: content structure/strategy
Next by Thread: Re: content structure/strategy


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads