Software Engineers Lean Documents

View as HTML

Overview

Notes and instructions to help fast track software development. Bringing the concept of daily small improvements to documentation, based on real-world problems. Information to make software engineers valued as pets rather than treated like cattle.

DevOps Topics

Topic	Description
Continuos Architecture	An operating model for architecture that moves away from design and implement approach (waterfall) to a continuous evolution via modern DevOps CICD using data driven architectural decisions and lean canvas concepts.
Ssh	Configure SSH on Windows
Terraform	Configure Terraform (infrastructure as code) on Windows
Automation with PowerShell	Long running resilient powershell scripts (Workflows)
Desired State Configuration	Long running resilient powershell scripts (Workflows)
Git Commands	Various Git commands for software engineers
Aws Cloud Devop	Configuring AWS cloud environment for software engineers

PowerShell Scripts

Topic	Description
Developer Tools	Configure Development tool on Windows
Install Server - WinRM SSL	Configure PowerShell remoting on a Server (Remote Management)
Install Server - Tools	Configure basic tools for a GUI server
Install Terraform	Install Terraform and associated tools
Git Hub CLI	Automate common tasks in GitHub with the CLI
Get Large Files	Find large files in a directory
Cloud - Azure Tools	Configure Azure tools on Windows
Cloud - Azure Git Repositories	Download all the git repositories for an organisation and project
Cloud - Infrastructure As Code Tools	Configure HashiCorp tools for infrastructure
Infrastructure - Console Load Balancer	Configure HashiCorp tools for load balancing

Code Topics

Topic	Description
Licensing your work	The licensing options available to software developers
Command Query Request Segregation - CQRS	A overview of the evolution of software architecture from simple Create, Read, Update and Delete models (CRUD).
Definition - “Production Ready”	A simple guide to build a production ready guideline for software
Migrating from AngularJS 1.5 to Angular 9+	The cost to retire the technical debt in the first generation Single Page Applications

Software Design

Topic	Description
Sustainability	Software Sustainability

Soft Skill Topics

Skills need to help provide a valuable service to you customers and maintain a positive working environment.

Topic	Description
Mental - Resilience	The capacity to recover quickly from difficulties
Mental - Mindsets	The qualities that high performing people have

Roadmap

Convert all real world notebook, notebook and various documents into a public repository of information. Share experiences with colleagues to help improve the productivity of software engineering community. Encourage others to hone communication skills within the industry.

Document objectives

1. Amalgamate sources of information in references section.
2. Provide a measure of success for each document.
   1. Determine the read/execution time for each document.
   2. Determine the time saved or value for each document.
   3. Encourage feedback/PR’s to improve the document.
3. Include any formula’s, cost benefit analysis involved with calculating success.
4. Provide a mechanism to include others metrics into the document.
5. Acknowledge authors contributions to the document.
6. Include License references for reuse.

Built With

GitHub Pages will run Jekyll

Contributing

Please read Contributing.md for details on our code of conduct, and the process for submitting pull requests to us.

Thanks to the Authors and contributors

License

This project is licensed under the Creative Commons License - see the LICENSE file for details

Acknowledgments

PurpleBooth - Contributing document template Conventional Commits