Recommendations for Creating a
GoldSim Style Guide
© 2020 GoldSim Technology Group LLC
Last updated January 15, 2020
This guide provides ideas and recommendations for consistent conventions, organization and documentation of a GoldSim model. This guide can be used to assist with writing your own style guide or set of standards for building GoldSim models within an organization. While consistency with a style guide is important, consistency within your project is more important. Keep in mind that sometimes these recommendations may not be applicable. Use your best judgment when applying a consistent style to the organization and documentation of your model.
The intended outcome of using a style guide is to have a model that is readable. If you use styles that are different from ideas and options provided in this guide, that is fine so long as it produces the same result: a model that is easy to read by others.
This guide is organized into sections that describe various concepts that make up a model. Your model should be a document that can be read by others in an organized way, like you are telling a story about the system being modeled and provide clear steps on how to use it. It’s important to consider your audience throughout the process of building and documenting your model. Typically, those readers with little modeling experience will only view the interface but other modelers on your team with more experience will need to understand the functionality. A clearly documented and well-organized model with consistent styles will provide your readers with the ability to understand what the intended functionality is.
Please sign in to leave a comment.