No problem — Helpjuice means you can control exactly who gets access to what information. All this makes Helpjuice perfect for companies who want one strong Swiss army knife for all their knowledge management, instead of having to pay for, learn, and try to integrate several different software programs.
For example, the auto-generated code lets you easily publish a responsive mobile app to help guide your customers to the right solution. You can expect a large number of customization options and features, which gives this tool a bit of a learning curve. The interface is minimalistic and allows you to switch views between author, code, and preview.
Handy features include autocompleting search suggestions, which makes it easier for your users to find the right answer.
Best for: MadCap offers a suite of tools for document and content creation, with dedicated tools for interactive video, language translation, and screen capture. This makes Madcaps authoring tool Flare great for enterprises who prefer working with one provider tool instead of several.
You can also expect rich formatting options for customizing the look and feel of your material to fit your brand. While the tool does help you look stylish, it also features topic-based authoring and a project analysis tool to help you identify issues such as broken links, duplicate styles in stylesheets, and broken image links. Best for : HelpNDocs may not be as advanced as tools such as Adobe RoboHelp or Madcap Flare, but its simple, Windows-like interface makes it approachable even for less tech-savvy users.
A library of templates speeds up content creation. Paligo is especially useful for technical writers who need a way to manage complex technical documentation. Despite the advanced features, you can still count on a clear, appealing overview with the clean interface:. Best for : HelpSmith is excellent for those who want an easy-to-use tool that produces simple help web pages and documents. The single media repository for media, such as images and videos, makes it easy to use files in several different projects.
You can also merge projects for working on translations or bringing in technical writers. Best for : Dr. Explain is useful for software development companies that need an affordable solution, whether freelancers, studios, or larger companies. For those who need to explain and create help documentation for their software, Dr. Explain could be a good fit. Do you have a multinational team or customer base?
Then this help authoring software might be of interest. It also supports various font faces, including Unicode, which makes it possible to create help documentation in, for example, Arabic or Chinese languages. Best for : ClickHelp is for teams who need a robust help authoring software but want to skip the complexities.
This cloud-hosted solution boasts support for rich topic content, such as quizzes, videos, and survey forms. Apart from single-source authoring, you can also reuse content across different projects. One handy feature is the conditional content ability to tag content for different users, meaning that you can save the more advanced help content for developers.
The tool also features convenient tools for external content creation and content review. The version control system makes it possible to work offline or edit remotely. The system checks out the topics as they are added and then adds them back in and compares them with the previous version when you finish editing. Best for: Confluence is built for sharing your public and internal technical documentation. You also have the option of purchasing third-party apps and custom themes for extra features.
Confluence is particularly attractive for teams who want a solution that integrates well with other tools. Depending on your needs, you can choose to host the software yourself or go for a cloud-based solution. While Confluence is a reliable option, it may be too advanced for smaller teams looking for a simple help authoring tool.
Here are a few things to keep in mind:. If you do not provide the required document properties for a content element, your Help documentation might not appear in the Help viewer. In an HTML file, the document properties are embedded as metadata elements. If you provide a supplemental HTML file, that file must have the same file name as the document file.
For more information about each document property, see Document Property Metadata Reference. A text value that specifies a unique ID value for a content element. However, you are not required to use a GUID. A text value that specifies the brief summary of the content element that appears in the search results in the Help viewer.
An enumeration value that specifies the document collection for the content element. This should be set to UserDocumentation. A semi-colon delimited collection of keyword entries that specify search terms for the content element. If a keyword matches a term in a search request, the search service ranks that content element higher in the list of the search results that appear in the Help viewer.
A text value that specifies the language for the content element. Use a language code to identify the language. The ms. To specify the preferred language for Help documentation, change the language code in the Alternative help language field of the User options form. A text value that specifies the publisher of the content element. Use the value that uniquely identifies the publisher. A semi-colon delimited list of publisher IDs.
Use the Hide Publishers property to prevent the Help viewer from displaying conflicting or outdated information for a specified topic. The Help viewer hides the content elements from the specified publishers. However, the hidden content element is still available and can be accessed from the Help viewer.
A semi-colon delimited list of Topic IDs. Use the Topic ID field to associate the content element together with a class, form, or other object in the Microsoft Dynamics AX client. The Topic ID enables you to supply context-sensitive help information for the specified class, form, or other object.
For more information about context-sensitive help, see Context Sensitive Help. The following code example shows the metadata elements that you use to add the document properties to the HTML of a content element. You use the content attribute to specify the value for each property. A link is the text in a content element that you click to open another content element in the Help viewer. You add links to a content element when you want to provide access to related Help documentation.
Typically, you add links that open other content elements on the Help server but you can link to documentation on other web sites. You can also use this element to open related Help documentation that is published outside the Help server.
However, links to documentation that is located outside the Help server opens in a browser window and not the Help viewer. You use the topicID and documentSet attributes to specify the content element you want the link to open. The link is active when you view the content element in the Help viewer. If you view the topic in an editor or browser, the link is not active. To specify the content element that you want to appear when you click the link, you use the value of the Microsoft.
F1 document property of the targeted content element. You use the Hyperlink button in the Insert tab of the Word ribbon to add a link. Use the URL to specify the file you want to open. When the Word template creates the. If you later deploy the topic to another server or folder on the server, the specified link might not work.
For more information about using hyperlinks with. If you create documentation that refers to individual controls on forms and other user interface UI components, you might want to use the text from those controls in your documentation. You typically use labels when you create documentation for forms that support more than one language.
You can use labels to show the specified text in the same language that is displayed by the form. The language you see is specified by the Language field of the User Options form. To use labels, you have to use HTML to create the content element. The Help server performs label replacement with only. When you use a label in your document, the Help server retrieves the label from the Application Object Server and inserts the text from that label into your documentation.
You can add images like screenshots or illustrations to your Help documentation. The images help the reader follow a lengthy procedure or better understand complex information.
In addition, you can add more than one image to the content elements that you create. To use an image, you have to place the image in a separate file. You then use the filename to import the image to the content element. When you publish the content element you might have to place the image files for that topic on the Help server. The image files are found in Art and Local folders of the Microsoft content folder on the Help server.
To minimize the impact of an update on your custom documentation, you should copy the Microsoft Dynamics AX image files you want to use to a separate folder. You then use the src attribute of that element to specify an image file. Contents Exit focus mode. In this article. Designing a Help System. This section contains a complete list of basic tasks. You will combine these tasks in various ways as you design and create your help system.
0コメント