Naming for documentation

As with any technology, it is highly recommended that you develop naming conventions (sometimes referred to as a naming style) for your knowledge objects (including the files you upload to Watson, and any data sources you set up using the professional version of Watson) before you begin developing them or using them. That is the trick.

Developing the naming conventions

It is difficult to create workable conventions or standards unless you have experience and are familiar with what objects can be created within Watson and each objects purpose. Generally speaking, more mature organizations will adopt styles used with other technologies, which you'll need to learn and adhere to. In new or less mature shops, it'll be up to you.

You can cultivate naming conventions for almost every kind of knowledge object in Watson, but what will this standard naming really do for you?

Organized naming conventions

Using consistent naming, for example, a prefix for all objects intended for a specific purpose, will naturally show object associations. If I prefixed all of the objects created for demoing in this book with book_demo_, then they would easily stand out (from all the other objects in my Watson collection). Additionally, I could be more specific, like naming all of the dashboards book_demo_dashboards_. This would create groups within my book demo list of objects.

Object naming conventions

Object naming can also be used to describe the purpose of an object. For example, an object named historic_stadium_sales_ indicates that the object focuses on the historic stadium sales file. You might want to include the following information in the object name:

  • The type of object (dashboard, prediction, company logo image, and so on)
  • The file name used (for a Watson Prediction, for example)
  • The timeframe represented
  • Its purpose

Hints

  • Start early: The sooner you start adopting a convention or style the better, since later (once there are potentially many, many objects already created and in use) it will be confusing to have to sift through and rename, and so on.
  • Be consistent: Make sure that you choose a style that can be easily followed by you and all of the users in your organization. If everyone consistently follows the convention, it will become easier to use as time goes by.
  • Be reasonable: Use a style/convention that makes sense and is easy to understand and use. If you don't, the convention will most likely be abandoned or at least avoided. In addition, use conventions only when it makes sense to do so, not just because it is the standard.
  • Forward think: At this time, I do not believe that there is any globally adopted Watson standard naming convention or style, but it does make sense to adopt one of your own and offer it to the Watson online community. This way, you may receive constructive feedback and perhaps play a role in standardizing the technology!
..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset