RE: Reference Architecture document

Subject: RE: Reference Architecture document
From: Sion Lane <sion -dot- lane -at- unit4 -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 30 Jun 2016 10:24:10 +0000

Hi Helen,

I would be most eager to engage with the actual deployment engineers. You will probably find that they have already documented what you need internally and you can use that as a basis for what you produce.

Cheers,
Sion

-----Original Message-----
From: techwr-l-bounces+sion -dot- lane=unit4 -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+sion -dot- lane=unit4 -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of techwr-l-request -at- lists -dot- techwr-l -dot- com
Sent: 30 June 2016 06:55
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: TECHWR-L Digest, Vol 128, Issue 19

Send TECHWR-L mailing list submissions to
techwr-l -at- lists -dot- techwr-l -dot- com

To subscribe or unsubscribe via the World Wide Web, visit
http://lists.techwr-l.com/mailman/listinfo/techwr-l
or, via email, send a message with subject or body 'help' to
techwr-l-request -at- lists -dot- techwr-l -dot- com

You can reach the person managing the list at
techwr-l-owner -at- lists -dot- techwr-l -dot- com

When replying, please edit your Subject line so it is more specific than "Re: Contents of TECHWR-L digest..."


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

Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

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




Today's Topics:

1. RE: suggestion box on intranet (Janoff, Steven)
2. Re: suggestion box on intranet (Tony Chung)
3. Re: suggestion box on intranet (Gene Kim-Eng)
4. Re: suggestion box on intranet (Peter Neilson)
5. Reference Architecture document (Helen Mullally)
6. Re: Reference Architecture document (Peter Neilson)


----------------------------------------------------------------------

Message: 1
Date: Wed, 29 Jun 2016 18:30:24 +0000
From: "Janoff, Steven" <Steven -dot- Janoff -at- hologic -dot- com>
To: Erika Yanovich <ERIKA_y -at- rad -dot- com>, TECHWR-L Writing
<techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: RE: suggestion box on intranet
Message-ID:
<28768db4d89346caa4ef97717fee9796 -at- USMARCORPEXCH08 -dot- hologic -dot- corp>
Content-Type: text/plain; charset="us-ascii"

Yammer, maybe?

Steve

On Tuesday, June 28, 2016 9:04 PM, Erika Yanovich wrote:

At my work, I am also responsible for the corporate intranet content and I need as many inputs as possible on the following 2 questions.

1. On any company intranet you know, is there a suggestion box where employees are encouraged to share improvement suggestions, innovation ideas, pics and inspiring anecdotes from their personal experience?

2. If yes, how is it being used?
Thanks very much in advance.
Erika



------------------------------

Message: 2
Date: Wed, 29 Jun 2016 12:27:28 -0700
From: Tony Chung <tonyc -at- tonychung -dot- ca>
To: Erika Yanovich <ERIKA_y -at- rad -dot- com>
Cc: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: Re: suggestion box on intranet
Message-ID:
<CAPnOPiHWSXrJk4FrXedks=WaAr-bLrEPGKcFYUJYMx2wR8BPPw -at- mail -dot- gmail -dot- com>
Content-Type: text/plain; charset=UTF-8

We are interested in all sorts of internal "Suggestion Box" type ideas.
We've standardized to Jira tickets and a community forum built on Jive.
People submit topics in Jira or on the forum and others vote with their comments. They can suggest or comment on just about anything related to improve products, processes, and people.

Our docs team demoed UserVoice for doc-specific issues, because it has a voting engine. But as priorities dictate our direction, we aren't so concerned in the number of votes. We only need to find the interested parties who could help build the requirements. The discussion oriented forums provide better context, and are more meaningful.

-Tony

On Tue, Jun 28, 2016 at 9:04 PM, Erika Yanovich <ERIKA_y -at- rad -dot- com> wrote:

> At my work, I am also responsible for the corporate intranet content
> and I need as many inputs as possible on the following 2 questions.
>
> 1. On any company intranet you know, is there a suggestion box where
> employees are encouraged to share improvement suggestions, innovation
> ideas, pics and inspiring anecdotes from their personal experience?
>
> 2. If yes, how is it being used?
> Thanks very much in advance.
> Erika
>
>


------------------------------

Message: 3
Date: Wed, 29 Jun 2016 12:54:35 -0700
From: Gene Kim-Eng <techwr -at- genek -dot- com>
To: Tony Chung <tonyc -at- tonychung -dot- ca>, Erika Yanovich <ERIKA_y -at- rad -dot- com>
Cc: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: Re: suggestion box on intranet
Message-ID: <6b225e60-e61d-695e-b250-16489aa29adc -at- genek -dot- com>
Content-Type: text/plain; charset=windows-1252; format=flowed

The biggest hurdle in getting employees to use a suggestion box, whether it's putting cards in a box or online, is convincing them that company management is actually reading the suggestions, implementing the ones that are positive and not retaliating against the people who submit the ones they don't like.

And most users of intranets know perfectly well that their suggestions won't be anonymous because management can always find out who is doing what on them.

Gene Kim-Eng


------------------------------

Message: 4
Date: Wed, 29 Jun 2016 16:33:58 -0400
From: "Peter Neilson" <neilson -at- windstream -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: suggestion box on intranet
Message-ID: <op -dot- yjt52wnjrns8nc -at- odin>
Content-Type: text/plain; charset=utf-8; format=flowed; delsp=yes

On Wed, 29 Jun 2016 15:54:35 -0400, Gene Kim-Eng <techwr -at- genek -dot- com> wrote:

> The biggest hurdle in getting employees to use a suggestion box,
> whether it's putting cards in a box or online, is convincing them that
> company management is actually reading the suggestions, implementing
> the ones that are positive and not retaliating against the people who
> submit the ones they don't like.
>
> And most users of intranets know perfectly well that their suggestions
> won't be anonymous because management can always find out who is doing
> what on them.

Indeed. The best version is the traditional box on the wall in the lunchroom. Even then, some will fear that there is a spy watching to see who put in the latest suggestion.

From what I have observed, some companies do not have a tradition of instilling fear, while others certainly do. "The beatings will continue until the morale improves!"


------------------------------

Message: 5
Date: Wed, 29 Jun 2016 20:56:03 +0000
From: Helen Mullally <helen -dot- mullally -at- alfresco -dot- com>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Subject: Reference Architecture document
Message-ID: <BD5B349E-2570-4B60-98E2-6174428DFA40 -at- alfresco -dot- com>
Content-Type: text/plain; charset="utf-8"

I?ve been asked to take on the creation and production of a Reference Architecture document, covering the hardware, software, and processes for a deployment. The document is intended primarily to support the sales process, rather than being a part of the product documentation.

Has anybody got any experience of writing or managing the production of a Reference Architecture document?

Do you have any advice on the typical SMEs to assist with the definition of the architecture and contributing to the content? Did you encounter any pitfalls or conflicts?

Thanks for any advice.

Helen




------------------------------

Message: 6
Date: Wed, 29 Jun 2016 17:30:29 -0400
From: "Peter Neilson" <neilson -at- windstream -dot- net>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Reference Architecture document
Message-ID: <op -dot- yjt8o3bgrns8nc -at- odin>
Content-Type: text/plain; charset=utf-8; format=flowed; delsp=yes

On Wed, 29 Jun 2016 16:56:03 -0400, Helen Mullally <helen -dot- mullally -at- alfresco -dot- com> wrote:

> I?ve been asked to take on the creation and production of a Reference
> Architecture document, covering the hardware, software, and processes
> for a deployment. The document is intended primarily to support the
> sales process, rather than being a part of the product documentation.
>
> Has anybody got any experience of writing or managing the production
> of a Reference Architecture document?
>
> Do you have any advice on the typical SMEs to assist with the
> definition of the architecture and contributing to the content? Did
> you encounter any pitfalls or conflicts?

The major pitfall is to include a discussion of futures. If the "official documentation" claims that the product, or an expected enhancement to the product, is to have Feature X, then the failure or inability of the company to provide that feature may cause anything from lost sales to legal action.

How to handle the situation? That's usually beyond the writer's control, except that we might refuse to include lies. Back in the dark ages I saw a "computer" produced by a self-styled engineer in Brooklyn. He claimed it operated at one and a half times the speed of light, which he called "1.5L". I felt fortunate not to be writing his ads.

Another difficulty is that the specifications will slither around underneath you as you try to write. Eventually the slippage of the project (caused by bad engineering or bad design) will be blamed on the poor quality of the tech writing. Try to avoid that situation.

A third difficulty is that you will be called upon to do mind reading.
Your inability to produce solid documents from vague hand-waving will be your downfall.


------------------------------

_______________________________________________
You are currently subscribed to
TECHWR-L.
To unsubscribe send a blank email to
http://lists.techwr-l.com/mailman/listinfo/techwr-l
Send administrative questions to admin -at- techwr-l -dot- com -dot-

Visit
http://www.techwhirl.com/ for more resources and info.

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives

End of TECHWR-L Digest, Vol 128, Issue 19
*****************************************

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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


Previous by Author: RE: To capitalize or not?
Next by Author: RE: Voice Prompts
Previous by Thread: Re: Reference Architecture document
Next by Thread: Access to Acrobat Help after End of Life support?


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

Sponsored Ads


Sponsored Ads