{"id":646,"date":"2020-01-08T12:31:57","date_gmt":"2020-01-08T12:31:57","guid":{"rendered":"https:\/\/sdf-docs.mansystems.com\/docs\/acr-rules\/project-hygiene\/large-entities-should-have-documentation\/"},"modified":"2022-06-15T06:52:34","modified_gmt":"2022-06-15T06:52:34","slug":"entitydocumentation","status":"publish","type":"docs","link":"https:\/\/sdf-docs.clevr.com\/?docs=acr-rules\/project-hygiene\/entitydocumentation","title":{"rendered":"Large entities should have documentation"},"content":{"rendered":"\n<p> When you have a large entity, adding documentation (e.g. choices of associations) can improve maintainability.   Upon problems, another developer can quickly see what it is used for.    <\/p>\n\n\n\n<p> Add a minimum amount of attributes before documentation is required. Also, it can check on the minimum amount of characters.    <\/p>\n","protected":false},"featured_media":0,"parent":100,"menu_order":18,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-646","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/646"}],"collection":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=646"}],"version-history":[{"count":1,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/646\/revisions"}],"predecessor-version":[{"id":647,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/646\/revisions\/647"}],"up":[{"embeddable":true,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/100"}],"next":[{"title":"Layouts should be prefixed properly","link":"https:\/\/sdf-docs.clevr.com\/?docs=acr-rules\/project-hygiene\/layoutprefix","href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/1513"}],"prev":[{"title":"Health check project microflow should be named properly","link":"https:\/\/sdf-docs.clevr.com\/?docs=acr-rules\/project-hygiene\/projecthygieneprojecthealthcheckname","href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/1535"}],"wp:attachment":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=646"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=646"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}