General Topics > News and Announcements

New Site for User and Developer API manuals

(1/2) > >>

We are in the process of improving our documentation site and built new easy to use interface with user manuals, developer API and community extension management site.


- Easy to navigate manual and easy to read on mobile and regular computers (responsive)
- Collaborative, so readers can post comments
- Secure

Thinking to use WordPress.

Any ideas or suggestions?


Don't use wordpress.

What you have is fine, application wise.

You need to settle on a document structure, then stick with it.  The current site appears to start to chunk the content down, then stuff the content into big pages.  I could rebuild that, and would be happy to help.

Possible concept:  Start a 2nd such such wiki site to handle building new documentation before each release.  Then export the content and import it into the live site to update.


Thank you for your comments and offer to help. We will give it some more thinking.

Why you do not recommend wordpress? Based on initial review it fits exactly what we need.

I look to match the use of the content to the structure of the presentation.

Blogs are optimized around a journal or log type presentation - reverse chronological order is the primary presentation order.  This is not a terribly useful basis for browsing.

I know that it has become popular in recent years to consider search an adequate substitute for good in-site indexing (ie well structured navigation) but this is just false.

In short, a blog is a great place to build a development or operations "COOKBOOK" - but not a manual.


I agree with Nimitz's perspective pertinent to "good in-site indexing (ie well structured navigation)"   I tend to be a self learner and encounter much frustration in on-line manuals lacking a good site indexing.   A search is usually ineffective as it depends on knowing key words being used pertinent to a problem or solution being looked for.

For example I recently in the past week just down loaded Abantecart v1.2 (currently using a different shopping cart) and run into frustration trying to learn how to configure and manage the cart by jumping to Wikipedia, this forum, and available install and user manual.   It's also initially a bit confusing that useful extension that are desirable are browsed for in the extension store and no clear advice is disclosed if it integrates to work properly with the most current version.

For the most part I'm discovering Abantecart is robust and allows one-way-or-another easy configuration changes but some are bit more difficult with little if any clues provided.  I also like the extension capabilities or rather he ability to easily customize that extensions provide.

For example, eventually I would like to remove the donate button that currently resides besides the "Powered By AbanteCart" text in the footer.  The reason being the donate button on the fielded shopping cart I feel will confuse customers as to why and to who they are being asked to donate money.  I was actually browsing the forums looking for a solution clue to do something else when I stumbled onto,2677.0.html .

Two adequate solutions were provided to remove the "Powered By AbanteCart" text.  I certainly went to the file in HTML mode and looked at the code  and even so in the new version it is on a different line and I will need to study the code a bit more to find the donate button code and either delete it or turn it off.

This points out another confusion factor of having a new version fielded while legacy versions are fielded that have significant code differences.  It mat be wise to have separate legacy version documentation and current version when the newest current version has significant code changes.

Overall Abantecart is growing in favor with me, it's just taking a bit more time and effort than I anticipated to get cart in use on my wife's (The Gift Basket Lady) website.

I just Google searched "wordPess" and the what improvement gain it is expected to provide Abantecart end-users appears unclear to me.  WordPress appears just to be another type of web content management system where the usefulness is determined by the quality of the content created that appears to be blog and discussion forum oriented rather than in itself being the manual.

I forgot to mention I searched YouTube and found how to configure Abantecart help videos.  How to video are great, but here again the usefulness of such videos is keeping them current.  The effort in managing video availability with current and correct information is not resolved by wordpress as it requires human interface more so than the "specific" platform making the videos findable and available.

Although digital and word processing technology makes paper somewhat obsolete a technical or user manual still needs to be structured with chapter content list (sections) and important word/key word/critical information word indexed.  In this regard Technical writing is performed by a technical writer and perhaps seeking out a technical writer may be more useful than playing musical forum, blog template switching as switching online format presentation still needs the effective technical manual and user manual to employ on the web for others to use.


[0] Message Index

[#] Next page

Go to full version
Powered by SMFPacks Social Login Mod