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: Knowledge Base software (was ghost town) From:Haim Roman <haim -dot- roman -at- gmail -dot- com> To:Andrew Harvie <withanie -at- gmail -dot- com> Date:Thu, 20 Feb 2014 18:42:50 +0200
Other than a forum or wiki or something similar, I don't know how else you
can get user input. On the other hand, you can set it up so that a login
is required to access the site, or at least write to it (we implemented
both options for wikis using MediaWiki software, which is what Wikipedia
runs on). If that's not secure enough, maybe add a one-time password
mechanism.
Another issue is how much you want to control what's written, even by
registered users. Wikipedia simply allows everyone to edit. If that's not
acceptable to you, then maybe do the following (I'm using MediaWiki in this
example):
- allow users to only edit the Talk pages associated with each article,
instead of the article itself.
- then you need some writers to review the Talk pages periodically &
incorporate the "good stuff" into the article itself.
_______________________________________________________________
Howard (Haim) Roman -- haim -dot- roman -at- gmail -dot- com -- 052-8-592-599 -- ×××× ××××
On Thu, Feb 20, 2014 at 4:46 PM, Andrew Harvie <withanie -at- gmail -dot- com> wrote:
> If I may change the direction of the thread, this is directly relevant to a
> project that my employer is interested in. We want to maintain an on-line
> knowledge base for our product. One of the requirements is that registered
> users (customers) be able to contribute. Also, that my documentation, in
> HTML5 format, be directly linked to and searchable from the same user
> interface.
>
> MadCap's forums use phpBB. Some folk here don't like the idea of any forum
> software since past experience has shown that forums attract the interest
> of hackers, or at least automated hacking tools. Kevin's comment about the
> search feature in phpBB is also relevant. This doesn't mean that phpBB (or
> similar forum software) is entirely out of the question, just that there is
> a preference to look for a different solution.
>
> So, if you were attempting to set up a knowledge base, what would you do?
>
>
> On Wed, Feb 19, 2014 at 3:51 PM, McLauchlan, Kevin <
> Kevin -dot- McLauchlan -at- safenet-inc -dot- com> wrote:
>
> > Supposedly, one of the premiere authoring tools is MadCap Flare. It
> > happens to be our weapon-of-choice, here at goode-olde-employer-inc.
> > The primary means by which serious users find out how to do things in
> > Flare is via MadCap's user forums.
> > (Note, I did not say via their own Help, nor via mailing lists.)
> >
> > As it happens, the search engine provided by MadCap for people wanting to
> > find stuff in their hosted forums has been a superlative example of an
> > absolutely useless, utterly putrid piece of @#&p!
> > Nobody I know of uses it. Anyone who finds useful info in those forums
> > (and there's a lot of really good user-to-user assistance to be found)
> does
> > it via external Google search.
> >
> > What's sad is that the company was built on Help, and they flog webserved
> > help with a search engine.
> >
> > If the MadCap forum search isn't embarrassing to MadCap, it should be.
> > But apparently they tolerate embarrassment really well, since the forum
> > search has been a running joke for about as many years as I've been using
> > the (pretty good) Flare product (i.e., since version 1.something).
> >
> > I don't know of a forums app/server that provides a really good search
> > facility. Do you?
> >
> >
> >
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Doc-To-Help: new website, content widgets, and an output that works on any
> screen.
>
> Learn more: http://bit.ly/1eRs4NS
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as haim -dot- roman -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
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Doc-To-Help: new website, content widgets, and an output that works on any screen.