Skip to Main Content
InterSystems Ideas
We love hearing from our users. Tell us what you want to see next and upvote ideas from the community.
* Bugs and troubleshooting should as usual go through InterSystems support.
Status Future consideration
Categories Documentation
Created by Pierre LaFay
Created on Dec 21, 2023

Best practices in a documentation chapter

I think it would be interesting to address in a chapter of the documentation good practices both in programming and in the design of persistent classes.

It would be ideal to present some code examples.

Some examples to illustrate my point:

How to transform a data transfer Object (dynamic object) coming from a Rest API to create a persistent object?

How to implement design patterns (factory, facade, query-builder, etc.)?

In which case to favor the object approach of persistent classes over the SQL approach and vice versa.

  • ADMIN RESPONSE
    Dec 3, 2024

    Thank you for submitting the idea. The status has been changed to "Future consideration".

    Stay tuned!

  • Josh Lubarr
    Reply
    |
    Dec 3, 2024

    LS Documentation management reviewed this. We agree that having more best practices is a good idea.

    Given the extremely wide breadth of our content, we would want to add specifics in particular areas. Further, we don’t have this information available to us, so an authoritative source would need to provide it for each area -- this is in part because we sometimes get conflicting information from multiple parties and are not the arbiter of such decisions. If anyone has specifics that they'd like us to add, they should contact PM or Dev Mgmt for the relevant area to move forward.