Skip to content

Documentation

The documentation consists of three parts:

  • Technical
  • Sales
  • Marketing

Technical

There should be enough technical documentation for anyone from Lime Technologies Expert Services organization to be able to understand, install and configure the add-on.

  • EXTTechnical documentation: Should be built using MkDocs and presented online, linked to from the Lime CRM Technical Wiki. Should be targeted towards Lime Technologies Expert Services as well as external people with corresponding technical competence. Everything should be stored in a folder called docs and a file called mkdocs.yml, containing the settings used. Run lime-project generate docs mkdocs to generate the markdown files needed:
    • index.md: Easy to understand overview of customer value added and features.
    • requirements.md: States which technical requirements this add-on has. For example: the oldest Lime CRM version that is supported, if the Lime Bootstrap framework is needed etc.
    • howitworks.md: Describes more in detail what it actually does.
    • installation.md: Complete instructions for new installations.
    • configuration.md: Describes how the add-on can be configured. Contains a complete config example for how to use it in the latest Lime CRM Base Solution.
    • upgrading.md: Complete instructions for upgrading a preexisting installation. Any new major versions (which implies breaking changes) must be described here, along with a complete todo list for being able to upgrade from an earlier version.
    • technical.md: Contains a technical description of the add-on. How is it built? Using which tools or components? Field mappings? Etc.
    • troubleshooting.md: Gather common troubleshooting tips. For example by having subheaders for Description and Solution.
    • gdpr.md: If any personal data is displayed/stored/used by the add-on, this should be documented by answering the following questions.
      • What does the add-on do with the personal data? (Display/store/use etc.).
      • Why does the add-on need the personal data?
      • What personal information is it?
      • If personal data is transferred to other systems, how is this done?
      • Is any personal data logged? If so, what data, where and when is it logged and when are the logs deleted?
      • Could the add-on be configured in any way to avoid using personal data?

Sales

  • EXT – A PowerPoint presentation, ready to show or send to customers. Should focus on key features and created customer value, contain an easy overview of the functionality, described user flows and step-by-step instructions of how to work with the add-on.
  • EXT – Gif or movie demoing the add-on.

Marketing

  • EXT – Prepared texts and images for Lime Technologies' website. The material should be targeted towards prospects and existing customers that currently do not have the add-on. The Marketing department at Lime Technologies will provide a template document specifying which information is required.