KB Creating/Editing/Translating Articles

Transcription

1 KB Creating/Editing/Translating Articles Revised: April 24, 2012 by Evgeny Konstantinov skype: evkonst Acronis, Inc.

2 CONTENTS Intro General Guidelines Creating an Article Editing an Article Translating an Article Things to Remember

3 INTRO Acronis KB is based on Drupal. See drupal.org if interested. It s a plus if you are familiar with basic HTML editing. We are using a WYSIWYG editor to write content. If you need to create SER content, you may want to get familiar with: Acrowiki SER; KB Public: Acronis Smart Error Reporting; KB: Internal: Salesforce: SER Error Code ; KB SER Code Live Reporting; Reporting Portal: SER Clicks. If not sure or no time to invest in these resources, consult with Evgeny Konstantinov. (!) Whenever you create and edit an article, the KB Team is automatically notified. Be sure that your contribution will be processed and your colleagues and Customers will benefit from it.

4 GENERAL GUIDELINES The more visual we are, the better. I.e. it s always good to use screenshots. Screenshots should be in *.png (note not jpeg converted to *.png) We may want to link to other KB articles or resources from within the article. We do not want to duplicate content if some procedure has already been described in the KB, just link to it. You may want to check our short style guide. See Knowledge Base Style Guide. It s best if an article annotation is informative. If there s a solution, you may want to describe it in a few words in the annotation. When putting in an error message, give preference to a specific one (instead of a generic one). E.g. generic: Acronis Backup & Recovery engine failed to run; specific: Failed to enumerate registered VMware vcenters. If you are not sure, you want to search the KB first to see if the error message is already there.

5 CREATING AN ARTICLE Log in at Click Create content -> Article:

6 CREATING AN ARTICLE Fill in the following fields: Title: Should start with the product name followed by a colon; Article Type: SER Message, How-to, Guide, Description or Known Issue Event Codes: enter one or more if you are creating SER content Do not put in anything in the BUG IDs field Put your JIRA task in the Internal Comment field

7 CREATING AN ARTICLE Check the Segments, Products, Components, and Operating Systems. You do not need to fill anything else.

8 CREATING AN ARTICLE Now that you have it all filled out, save. Scroll down to the WYSIWYG window and hit the template button. Select the respective template

9 CREATING AN ARTICLE Now, save twice and see if the annotation disappears. If it does, hit Templates again. If it does not, proceed. This is a known issue.

10 CREATING AN ARTICLE Sometimes you may want to edit/fix smth in the HTML source (e.g. this is the only way to create bullets with sub-bullets). To do this, hit Source:

11 CREATING AN ARTICLE If you need to insert a picture (always a welcome thing), use the Images module at the bottom:

12 EDITING AN ARTICLE To edit an existing article, click Edit: The rules of working with the existing text are the same as with creating a new article. (!) It s always a good thing to check whether the article you are editing has a translation or not. If it does, you are welcome to update the same piece of text in the language you are familiar with.

13 TRANSLATING AN ARTICLE Select the language you are willing to translate to and click add translation: The rules of working with a translation are the same as with creating a new article. (!) When translating an article, make sure all the terms have proper translation. E.g. do not do literal translation of Acronis or Windows services. Instead look them up in the system and copy the correct names.

14 THINGS TO REMEMBER Annotation may disappear on first or second Save. Make sure it doesn t before you start writing. Do not copy & paste into the article body from any source other than plain text. If you have to paste some text, make sure it s plain (e.g. from Notepad) or use the WYSIWYG s feature: If you need to link to a different KB article, use freelinking copy and paste the exact title of the article to which you refer and put it in double square brackets: Do not Use IE9 there are compatibility issues If you need assistance, you are always welcome to contact Evgeny Konstantinov via Skype, , phone or in person.