:: [DNG] What should an Install Guide …
Page principale
Supprimer ce message
Répondre à ce message
Auteur: Michael
Date:  
À: dng
Sujet: [DNG] What should an Install Guide accomplish?
Hi golinux and everyone else,

Okay, I’m breaking this topic off from the ‘Added desktop-live to the install
guides’ as it seems we have a much higher, philosophical level decision to
make before we can continue with editing the Devuan Install Guide. Which is:

== What should an Install Guide accomplish?


# # #

My take is that an Install Guide is a complete set of instructions that a
person can follow to fully accomplish the task. There are no ambiguities
presented to the user, as it is literally do step a), do step b), do step
c) ...

Each step should be fully explained and if there is more than one primary
method of doing any of the steps, then each method is explained. In this
case my take is that both Nix and Windows instructions should be available.

# # Minor points

= I am fully against against repeating any information on a website. As doing
so almost always leads to discrepancies between the difference sources. If
the Devuan site is using a CMS of some sort, then a single source should be
able to be created and block inclusions can be then placed anywhere else on
the site as needed. [1]

= I do think that anything a user needs to know to make an intelligent
decision should be either on the page or directly linked to. If linked to,
then clicking the link should not close or overwrite the Install Guide page.

= For an Install Guide I’m against ‘Minimalism.’ My feeling is that not
giving total, and literally an over abundance of information, not only
directly inhibits and stops people from doing the Install, but also creates
vast negative word of mouth from those who attempt the Install but can’t
complete it because they aren’t given enough information to physically be
able to follow it.

= If golinux agrees to ‘an over abundance of information approach,’ I have no
issue re-writing the whole guide. (As you may have noticed I’m a bit gabby.)
I will need someone with a Windows box to QC those instructions.

# # #

Okay, that’s my fairly opinionated opinion. I think ultimately this is
golinux’s decision, but please everyone else jump in with yea’s, nay’s, and
what you think the answer to the question is ;) Also, please don’t feel shy
about bringing up what you think the ramifications might be for the different
options/opinions/methods. I bring this last point up, as I have a gut feel
that if we come to agreement on the ramifications, then we’ll have
our ‘decision’ per say made for us.

Best Regards All and Happy New Year!,
Michael

PS: golinux, my full apologies if I’ve stepped on your toes :( and/or
exceeded what you’re willing to take under discussion.

[1] I host and manage Drupal (CMS) websites, this generally takes 10 minutes
to setup. I can discuss this offline with whoever as desired.