Bringing Order into Chaos for a Website with MadCap as CMS

This forum is for job posting and resume posting for any type of technical writing position using Madcap Software Products.
Post Reply
th3el
Jr. Propeller Head
Posts: 3
Joined: Tue Jan 19, 2010 6:51 am

Bringing Order into Chaos for a Website with MadCap as CMS

Post by th3el »

Background
TOP, THEE Online Project, is a website cluster now in Stage 1. A statement of TOP goals and a statement of the TOP website specs for Stage 1 are available separately. The TOP site has a home page with navigation to background material and a range of topic sites.

The topic sites explain and picture frameworks for understanding various practical matters of living. The CMS being used for these topics is Flare v5 and associated MadCap software applications.

Original material produced in several MS-Word documents has been imported into Flare v5. There are currently 3 Flare Projects: a “HubSite” which contains all the general information about the project in about 80 Flare Files, and 2 “Framework Sites” (or Satellite Sites) of about 200 Flare Files each.

These Flare Projects have been done by different people with varying levels of expertise and to different standards. It is evident that many files are messy, incomplete, with unnecessary tags, and a lack of consistency.

There are many more frameworks to be produced in Flare and posted in the coming years.

Task
The completed Flare work needs to be reviewed and altered to provide a suitable design and organization that uses Flare functionality to the full as appropriate for user needs, and provides consistency and ease of handling now and for new topics going forward.

Everything should be put into a single Flare Project so that formatting/style/look changes will be easier in the future.

Work to be done will include:
• Proper page layout with standard look and feel
• Provision for page versions and updating
• Page design with versions-date, link to forums, print & email buttons &c for website usability (liaise with web developer on this matter)
• Standard CSS file to apply to all pages
• Clarity about additional Style-Rules from existing rudimentary ideas
• Templates for later use
• Inserting hyperlinks where they are missing
• Provision of a glossary that allows textboxes to open on webpages
• Possibly an index
• Use of other Flare functionality as agreed
• Proofing (copy-editing) to remove mis-spellings, typos &c prior to delivery for posting

Liaison
1. With WK (Author). This is important because the material is unusual. The use of styles and colour to highlight words is somewhat incoherent and possibly overdone.
2. With Web Developer. A web development team is currently being recruited and the Flare files must be seamlessly incorporated in the information architecture, overall navigation and website design. Certain special software functionality may need incorporating into pages e.g. in regard to graphics.
3. With Graphic Designer. Use of icons to help usability and navigation need to be designed and inserted. Images and illustration may also be useful.

You can reach me at: warrenk@th3el.com
Contact me at: warrenk@th3el.com
Post Reply