Skip to content

Latest commit

 

History

History
64 lines (56 loc) · 7.11 KB

references.md

File metadata and controls

64 lines (56 loc) · 7.11 KB
Raw

References

Some Common Terms

The term definitions are provided in the context of information development.

  • Static Site Generators—Simply put, they take a template directory with raw text files in various formats, run it through a converter, and spit it out as a complete and ready-to-publish static website.
  • Wiki—A website or database which is developed by the collaborative efforts of users.
  • DITA—Darwin Information Typing Architecture (DITA) is a standard XML-based architecture for representing documents for consumption by humans. It provides architectural features for content modularity, content reuse, and controlled extension of document vocabularies.
  • DITA Open Toolkit—DITA is the principle while DITA Open Toolkit is what makes it come into practice. DITA Open Toolkit is an open-source publishing engine for XML content authored in the Darwin Information Typing Architecture.
  • Reusability—The ability of a chunk of text to be used in many places without altering it.
  • Module—The smallest possible chunk of content that can be reused.
  • Modularization—The ability to organize content into chunks that can be readily reused in many places.
  • Minimalism—In a nutshell: fewer words, greater impact; the right information in the right moment; avoiding adjectives in technical documentation.
  • Topic-Based Writing—The purpose of the information determines types of topics which serve a particular purpose and which, however, can be mixed:
    • Concept—Answers the question "What is this?" and provides descriptions.
    • Task—Answers the questions "How does this work?" and provides procedures.
    • Reference—Displays same-level information for user reference like in encyclopedias. This article is a reference topic.
  • Customer Journey—Involves every interaction with your company, product, or service and spans a variety of touchpoints by which the customer moves from awareness to engagement and purchase.
  • Customer Experience—Represents every step of the journey from when users are running price comparisons, try the product, to when users may resort to customer service if their needs aren’t met.
  • User Experience—The experience of the customer or user with a specific product such as a website, app, or software.
  • Persona—A representation of a fictitious user that includes a concise summary of characteristics of the user, their experience, goals and tasks, pain points, and environmental conditions. Personas describe the target users of a tool, site, product or application, giving a clear picture of how they're likely to use the system, and what they’ll expect from it.
  • Matrix—A grid that represents groups of people from your target audience in terms of who does what, helps determine the tasks and the expectations of each group from the documentation and the purpose the group will use it for.
  • Funnel Matrix—An analytical tool that determines the stages of customer conversion. A potential customer starts with the awareness for your product, then is interested in it, desires to buy it, finally, acts upon the desire and buys it.
  • Conversion Rate—The number of conversions (first-time buyers of your product or service) divided by the number of total ad clicks.

Some Handy Tools

  • Jekyll—A static site generator. It is also the engine behind GitHub Pages and you can also use it to host your project’s page, blog, or website from GitHub’s servers for free.
  • Hugo—An open-source static site generator.
  • GitHub—A web-based version control repository and Internet hosting service.
  • Jenkins—An open source automation server written in Java, which helps automate the non-human part of the software development process and facilitate the technical aspects of continuous delivery.
  • Confluence—A team collaboration software.
  • Atom—A free and open-source text and source code editor developed by GitHub.
  • Sublime—A proprietary cross-platform source code editor with a Python application programming interface.

Some Useful Resources