Skip to content

Improve self-onboarding for developers #61

@GauBen

Description

@GauBen

Developer self-onboarding does not focus enough on content edition experience. It always comes a by-product of the implementation and not as an initial requirement. Developer training should encompass the basics of content edition, including but not limited to, content folders, weak references, mixins, and so on.

Here is a list of questions that developers may have:

Content types

  • What are the available mixins?
  • Which content type should my content type inherit?
  • When to use mixins vs inheritance
  • When to use "extend" ?
  • Should I use booleans or mixin?
  • When to use child nodes vs multiple weakreferences?
  • When to split your cnd file?

....

Good practices to build authoring experience

  • Provide at least one template with just the header, the footer, and a way for business users to composer their page
  • Add helpers for your mixins, especially how it is used inside your code (views or else), describe the impacts
  • Avoid behaviors that are hard to understand for the business user
  • TBD: When to use editable = false
  • Add icons to content types
  • Add icons inside dropdowns when you can
  • When to use one or several component categories
    ...

Metadata

Metadata

Assignees

Labels

academyThis ticket involves documentation work on the AcademydocumentationImprovements or additions to documentation

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions