Knowledge articles - titles and formatting
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎10-16-2011 01:46 PM
In preparation of beginning to populate our knowledge base, I am interested to know if anyone has a specific naming convention that you are using to TITLE your knowledge articles?
Example:
MSWord - How to create a table
Same goes with the body of the text. Are you using a structured approach to formatting the body of the article in the wiki editor and are you using screen captures and/or linking to other articles?
1. From the file menu, click on Insert.
2. Click on the Table icon.
3. Blah, blah....
Thanks
- Labels:
-
Knowledge Management
- Mark as New
- Bookmark
- Subscribe
- Mute
- Subscribe to RSS Feed
- Permalink
- Report Inappropriate Content
‎10-24-2011 05:07 PM
Some basic formatting that I used for articles within our corporate website had to be simple for a few reasons. I found that by simplifying the markup, it was easier to get non HTML savvy people to properly edit the template. I also found that naming the classes based on the sections of the pages helped the legibility of the markup without knowing HTML.
Knowledge Article Title
Initial Page description
Paragraph one of page content
Sub heading
Paragraph two of page content, and so on to the end of the article
People not used to HTML still get what a paragraph is as well as a h1 through h6 tag is, they start to get shakey with tables and containers, so avoid complex HTML. The majority of our corporate website lives in the Knowledge base as articles. Why is this important? The authors don't have to think about the CMS or formatting fonts, only the article they need to publish. The second you start worrying about formatting in word, your day is lost. Keep the markup simple, let a designer handle the font declarations, and your people will love you for it.