Manufacturing Software Guidelines

This document presents some rules to create software.

ManufacturingSoftwareGuidelines.pdf

Table of content

• License and copyright
• Foreword
• Methodology
  • Agility
  • Dichotomy
  • Modeling
  • Documentation
  • Ecosystem
• Tools
• Programming
  • Paths
  • Naming
  • Commenting
  • Formatting
• UI design
  • Console
  • Forms
  • Web
  • Mobile
  • TV
• Using Git and GitHub
  • Naming artifacts
  • ZenHub boarding
• Appendices
• Bibliography

Changelog

2021.04.27 - Version 0.6

• Update tools and bibliography.

2020.07.03 - Version 0.5

• Upgrade from Word 2010 to Word 2019
• Update tools and bibliography.
• Some writing corrections.

2019.09.03 - Version 0.4

• Update tools and bibliography.

2019.01.14 - Version 0.3

• Add agility and articles about interface and singleton keywords.

2018.04.08 - Version 0.2

• The first word of "manufacturing", "building" and "crafting" was chosen for the title of this document because the second usually means "generating the machine code" during the production process and the latter is only recently used in our business and this word designates exactly what is our job which is to create software with our hands and with our minds, and we will always do that by this way.
• Since in French "développement" and "programmation" are synonyms but in English "development" means "engineering" the title of this document has been revised.

2018.04.05 - Version 0.1

• Initial draft.