Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • RAPID-MIX_API RAPID-MIX_API
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 31
    • Issues 31
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • rapid-mix
  • RAPID-MIX_APIRAPID-MIX_API
  • Issues
  • #33

Closed
Open
Created Sep 20, 2017 by Francisco Bernardo@franciscoOwner

API documentation fragmentation

Users' feedback reports about how the documentation of the different components is fragmented: different sites; different content, design and user experiences, and potentially, different authors.

Recommendations:

  • There should be a common medium, method and style for documentation, which will reduce the adoption friction.

  • ORM for MySQL, Postgres, loadash, underscore, KNX, and Processing, were given as reference examples of good documentation.

Assignee
Assign to
Time tracking