Tip | Commenting to document Dataiku objects#

Adopting a good dataset naming scheme avoids a lot of long descriptions and many comments. However comments are still very useful when collaborating with others (note that yourself in six months counts as someone else).

There are many places where a few words can be very useful:

  • A description on the project homepage. You can add links to datasets, recipes, or any element of the project.

    The project homepage with the description area outlined.

  • A description in the Summary tab of a dataset. Note this appears on the flow: click the dataset then details in the right column.

  • When publishing insights, you can add the link of the corresponding dataset in the description text.

    Map of Washington stations type, with link to dataset in description.

  • Edit column details to add a short comment.

  • Comments in the code of your custom recipes. There are many online resources about writing good comments. Just a few words:

    • Explain what you intend to do, what it will be used for. (How it’s done and what a recipe does is less important.)

    • Imagine that you’re taking the project over, what would you want to read here?

    • Time for some fun