Scope 36 Kyle documentation completeness review

Scope 36 Kyle documentation completeness review#

  • Scope ID: 36

  • Owner: Charlie Winans

  • Duration: 10 Hours

  • Date: 11/08/2024

  • Due: 11/08/2024

  • Actual Completion Date: 11/11/2024

Overview#

Create a scope template that can be used as a best practice standard for all future scopes. Also test the template to ensure it can be read by the documentation compiler utility at utilities/2_compileDocumentation.py to generate the scope _index.csv file as well.

Justification#

The Zen of Python, by Tim Peters:

Beautiful is better than ugly. Explicit is better than implicit. Simple is better than complex. Complex is better than complicated. Flat is better than nested. Sparse is better than dense. Readability counts. Special cases aren’t special enough to break the rules. Although practicality beats purity. Errors should never pass silently. Unless explicitly silenced. In the face of ambiguity, refuse the temptation to guess. There should be one– and preferably only one –obvious way to do it. Although that way may not be obvious at first unless you’re Dutch. Now is better than never. Although never is often better than right now. If the implementation is hard to explain, it’s a bad idea. If the implementation is easy to explain, it may be a good idea. Namespaces are one honking great idea – let’s do more of those!

Deliverables#

  1. Ensure this template is complete.

  2. Test the template to ensure it can be read by the documentation compiler utility at metacrud2/utilities/0_docsCompiler.py to generate the scope _index.csv file.

  3. Verify the existence of documentation site at docs.systems.exact.engineering including this scope.

  4. Verify the existence of a systems manager role for deploying the documentation site and that it is intuitive to navigate to and use.

  5. These should be checked by the development manager for completion of these items.

  6. Development manager should ensure all published scopes are standardized using this template.

  7. Development manager role should include these guides in the roles description and ensure the role is intuitive to navigate to and use.

  8. Ensure that daily responsibilities are uphelp on a daily basis for both the systems manager and the development manager.

Resources#

  1. PEP 20 - The Zen of Python