Re: 2. What's your preference: One long page or several small pages?

[John G <john -at- garisons -dot- com>]

Yeah - Expando is a pain.  But then, so is the progress bar and the
Previous/Next buttons on the thing we have implemented here ... kind of
another reason I want to make sure it's worth the pain of doing.

And then I recall Edmond Weiss' First Law of documentation: That which is
easy and best for the user is difficult and time consuming for the
documentor.


JG

On Fri, Aug 3, 2018 at 11:53 AM Tony Chung <tonyc -at- tonychung -dot- ca> wrote:

> Hey John,
>
> I found expansion macros time consuming and actually harder to implement.
> If this is the way your team decides to go, look into the Expando macro for
> automating the accordion function based on heading levels.
>
> Other options for long pages is a sidebar TOC. Before I left BMC they
> implemented a really skookum sidebar on their docs page:
> http://bit.ly/2ObHVg3
>
>
> As for personal preference, I much prefer shorter topics that focus on a
> specific concept. For web content, shorter pages give easier targets for
> people who search. For instance, the search for "test credit cards cognito
> forms" (without quotes) pulls this page automatically:
> http://bit.ly/2M0gdFr
>
> If this content were on a longer page, it might not be so easily found.
>
> Cheers,
> -Tony
>
> On Fri, Aug 3, 2018 at 8:44 AM, John G <john -at- garisons -dot- com> wrote:
>
> > We use Expand macros in places, but not for this. It's under
> consideration
> > too.
> >
> > JG
> >
> > On Fri, Aug 3, 2018 at 9:28 AM Kevin Ryan <kryan -at- harriscomputer -dot- com>
> > wrote:
> >
> > > RE:    2. What's your preference: One long page or several small pages?
> > >
> > > John,
> > >
> > > Have you considered hiding subsections/sub-instructions under
> > Confluence's
> > > Expand macro?  This might allow you to economize on screen vertical
> space
> > > and still keep the full load of information available for readers who
> > want
> > > it.
> > >
> > > Kevin Ryan
> > >
> > > Kevin Ryan
> > > Technical Writer, Research & Development
> > > P: 802-865-1170x82412
> > > F: 802-865-1171
> > > E: kryan -at- harriscomputer -dot- com
> > > 10 E
> > > Allen Street
> > > Suite 201
> > > Winooski, VT 05404
> > > www.ssivt.com
> > > This message has been sent on behalf
> > > of a company that is part of the Harris Operating Group of
> > > Constellation Software Inc. These companies are listed
> > > here
> > > .
> > > If you
> > > prefer not to be contacted by Harris Operating Group
> > > please notify
> > > us
> > > .
> > > This message is intended exclusively for the
> > > individual or entity to which it is addressed. This communication
> > > may contain information that is proprietary, privileged or
> > > confidential or otherwise legally exempt from disclosure. If you are
> > > not the named addressee, you are not authorized to read, print,
> > > retain, copy or disseminate this message or any part of it. If you
> > > have received this message in error, please notify the sender
> > > immediately by e-mail and delete all copies of the
> > > message.
> > >
> > >
> > ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> > Visit TechWhirl for the latest on content technology, content strategy
> and
> > content development | http://techwhirl.com
> >
> > ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> >
> > You are currently subscribed to TECHWR-L as tonyc -at- tonychung -dot- ca -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 vwritert -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