Software Development - Revision history

Andy Culbertson: Added "Introduction to the Guide" to the topic outline.

2023-05-10T15:32:56Z

Added "Introduction to the Guide" to the topic outline.

← Older revision		Revision as of 15:32, 10 May 2023
Line 11:		Line 11:
	The items under the SWEBOK knowledge areas in the first level link to my notes on each topic. I've sorted the knowledge areas to approximate my preferred order, though I'll address them more haphazardly.		The items under the SWEBOK knowledge areas in the first level link to my notes on each topic. I've sorted the knowledge areas to approximate my preferred order, though I'll address them more haphazardly.

			* '''Introduction to the Guide'''
	* '''Ch. 12: Software engineering economics'''		* '''Ch. 12: Software engineering economics'''
	* '''Ch. 11: Software engineering professional practice'''		* '''Ch. 11: Software engineering professional practice'''

Andy Culbertson: Moved "Ch. 10: Software quality" and "Ch. 6: Software configuration management" to just after "Ch. 7: Software engineering management."

2023-05-10T05:32:50Z

Moved "Ch. 10: Software quality" and "Ch. 6: Software configuration management" to just after "Ch. 7: Software engineering management."

← Older revision		Revision as of 05:32, 10 May 2023
Line 19:		Line 19:
	* '''Ch. 9: Software engineering models and methods'''		* '''Ch. 9: Software engineering models and methods'''
	* '''Ch. 7: Software engineering management'''		* '''Ch. 7: Software engineering management'''
			* '''Ch. 10: Software quality'''
			* '''Ch. 6: Software configuration management'''
			** [[/Version Control/]]
			** [[/Version Numbers/]]
			** [[/Distribution/]]
	* '''Ch. 8: Software engineering process'''		* '''Ch. 8: Software engineering process'''
	** [[/Software Development Methodology/]]		** [[/Software Development Methodology/]]
Line 24:		Line 29:
	* '''Ch. 1: Software requirements'''		* '''Ch. 1: Software requirements'''
	** Requirements		** Requirements
	* '''Ch. 10: Software quality'''
	* '''Ch. 4: Software testing'''		* '''Ch. 4: Software testing'''
	** [[/Testing/]]		** [[/Testing/]]
Line 31:		Line 35:
	** Architecture		** Architecture
	** UX and UI		** UX and UI
	* '''Ch. 6: Software configuration management'''
	** [[/Version Control/]]
	** [[/Version Numbers/]]
	** [[/Distribution/]]
	* '''Ch. 3: Software construction'''		* '''Ch. 3: Software construction'''
	** [[/Code Style/]]		** [[/Code Style/]]

Andy Culbertson: Boldfaced the top-level topics in the outline for easier reading.

2023-05-09T15:54:02Z

Boldfaced the top-level topics in the outline for easier reading.

← Older revision		Revision as of 15:54, 9 May 2023
Line 11:		Line 11:
	The items under the SWEBOK knowledge areas in the first level link to my notes on each topic. I've sorted the knowledge areas to approximate my preferred order, though I'll address them more haphazardly.		The items under the SWEBOK knowledge areas in the first level link to my notes on each topic. I've sorted the knowledge areas to approximate my preferred order, though I'll address them more haphazardly.

	* Ch. 12: Software engineering economics		* '''Ch. 12: Software engineering economics'''
	* Ch. 11: Software engineering professional practice		* '''Ch. 11: Software engineering professional practice'''
	** [[/License/]]		** [[/License/]]
	* Ch. 14: Mathematical foundations		* '''Ch. 14: Mathematical foundations'''
	* Ch. 13: Computing foundations		* '''Ch. 13: Computing foundations'''
	* Ch. 15: Engineering foundations		* '''Ch. 15: Engineering foundations'''
	* Ch. 9: Software engineering models and methods		* '''Ch. 9: Software engineering models and methods'''
	* Ch. 7: Software engineering management		* '''Ch. 7: Software engineering management'''
	* Ch. 8: Software engineering process		* '''Ch. 8: Software engineering process'''
	** [[/Software Development Methodology/]]		** [[/Software Development Methodology/]]
	*** [[/Iterative and Incremental Development/]]		*** [[/Iterative and Incremental Development/]]
	* Ch. 1: Software requirements		* '''Ch. 1: Software requirements'''
	** Requirements		** Requirements
	* Ch. 10: Software quality		* '''Ch. 10: Software quality'''
	* Ch. 4: Software testing		* '''Ch. 4: Software testing'''
	** [[/Testing/]]		** [[/Testing/]]
	* Ch. 2: Software design		* '''Ch. 2: Software design'''
	** Design		** Design
	** Architecture		** Architecture
	** UX and UI		** UX and UI
	* Ch. 6: Software configuration management		* '''Ch. 6: Software configuration management'''
	** [[/Version Control/]]		** [[/Version Control/]]
	** [[/Version Numbers/]]		** [[/Version Numbers/]]
	** [[/Distribution/]]		** [[/Distribution/]]
	* Ch. 3: Software construction		* '''Ch. 3: Software construction'''
	** [[/Code Style/]]		** [[/Code Style/]]
	** [[/Project Structure/]]		** [[/Project Structure/]]
Line 51:		Line 51:
	** [[/Logging/]]		** [[/Logging/]]
	** [[/Test-First Programming/]]		** [[/Test-First Programming/]]
	* Ch. 5: Software maintenance		* '''Ch. 5: Software maintenance'''
	** [[/Refactoring/]]		** [[/Refactoring/]]

Andy Culbertson: In the topic outline, moved "Software engineering models and methods" to just after "Engineering foundations."

2023-05-09T15:49:46Z

In the topic outline, moved "Software engineering models and methods" to just after "Engineering foundations."

← Older revision		Revision as of 15:49, 9 May 2023
Line 17:		Line 17:
	* Ch. 13: Computing foundations		* Ch. 13: Computing foundations
	* Ch. 15: Engineering foundations		* Ch. 15: Engineering foundations
			* Ch. 9: Software engineering models and methods
	* Ch. 7: Software engineering management		* Ch. 7: Software engineering management
	* Ch. 8: Software engineering process		* Ch. 8: Software engineering process
Line 30:		Line 31:
	** Architecture		** Architecture
	** UX and UI		** UX and UI
	* Ch. 9: Software engineering models and methods
	* Ch. 6: Software configuration management		* Ch. 6: Software configuration management
	** [[/Version Control/]]		** [[/Version Control/]]

Andy Culbertson: Condensed and updated the intro. Reordered the topic outline.

2023-05-07T05:04:28Z

Condensed and updated the intro. Reordered the topic outline.

@@ Line 1: / Line 1: @@
 == Introduction ==
-=== Purpose ===
+This is a collection of notes on software development. Its main purpose is to help me raise my development's level of professionalism. It also gives me a place to air an opinion or two.
-This project is a growing set of notes on various aspects of software development. Its purpose is to define a set of standard operating procedures for my programming projects.
+To give you an idea of my background, after some BASIC programming in my childhood and a break of many years for other interests, I returned to hobby programming just after undergrad and was able to make it my living several years later in 2006. That phase of my developer life started with Perl, and since then I've moved on to Python and XSLT. I've worked mainly in the area of text processing. JavaScript and PHP have played intermittent supporting roles for occasional web development or InDesign scripting. My projects have all been either solo or with a very small team. It's all been on Windows and mostly for the command line.
 == Topics ==
@@ Line 35: / Line 9: @@
 As a way to organize my notes and make sure I don't miss anything important, I'll use the structure of IEEE's ''Guide to the Software Engineering Body of Knowledge'' (SWEBOK). It's a standard that overviews the entire field and forms the basis for creating things like curricula and certifications. You can [https://www.computer.org/education/bodies-of-knowledge/software-engineering/v3 download the PDF] for free.
-The items under the SWEBOK knowledge areas in the first level link to my notes on each topic. I've sorted the knowledge areas to approximate my preferred order.
+The items under the SWEBOK knowledge areas in the first level link to my notes on each topic. I've sorted the knowledge areas to approximate my preferred order, though I'll address them more haphazardly.
 * Ch. 7: Software engineering management
 * Ch. 8: Software engineering process
@@ Line 43: / Line 23: @@
 * Ch. 1: Software requirements
 ** Requirements
 * Ch. 2: Software design
 ** Design
@@ Line 68: / Line 51: @@
 ** [[/Logging/]]
 ** [[/Test-First Programming/]]
 * Ch. 5: Software maintenance
 ** [[/Refactoring/]]
 == [[/Sources/]] ==

Andy Culbertson: Reordered the SWEBOK knowledge areas.

2023-04-16T05:56:10Z

Reordered the SWEBOK knowledge areas.

← Older revision		Revision as of 05:56, 16 April 2023
Line 35:		Line 35:
	As a way to organize my notes and make sure I don't miss anything important, I'll use the structure of IEEE's ''Guide to the Software Engineering Body of Knowledge'' (SWEBOK). It's a standard that overviews the entire field and forms the basis for creating things like curricula and certifications. You can [https://www.computer.org/education/bodies-of-knowledge/software-engineering/v3 download the PDF] for free.		As a way to organize my notes and make sure I don't miss anything important, I'll use the structure of IEEE's ''Guide to the Software Engineering Body of Knowledge'' (SWEBOK). It's a standard that overviews the entire field and forms the basis for creating things like curricula and certifications. You can [https://www.computer.org/education/bodies-of-knowledge/software-engineering/v3 download the PDF] for free.

	The items under the SWEBOK knowledge areas in the first level link to my notes on each topic.		The items under the SWEBOK knowledge areas in the first level link to my notes on each topic. I've sorted the knowledge areas to approximate my preferred order.

			* Ch. 7: Software engineering management
			* Ch. 8: Software engineering process
			** [[/Software Development Methodology/]]
			*** [[/Iterative and Incremental Development/]]
	* Ch. 1: Software requirements		* Ch. 1: Software requirements
	** Requirements		** Requirements
Line 43:		Line 47:
	** Architecture		** Architecture
	** UX and UI		** UX and UI
			* Ch. 9: Software engineering models and methods
			* Ch. 6: Software configuration management
			** [[/Version Control/]]
			** [[/Version Numbers/]]
			** [[/Distribution/]]
	* Ch. 3: Software construction		* Ch. 3: Software construction
	** [[/Code Style/]]		** [[/Code Style/]]
Line 59:		Line 68:
	** [[/Logging/]]		** [[/Logging/]]
	** [[/Test-First Programming/]]		** [[/Test-First Programming/]]
			* Ch. 10: Software quality
	* Ch. 4: Software testing		* Ch. 4: Software testing
	** [[/Testing/]]		** [[/Testing/]]
	* Ch. 5: Software maintenance		* Ch. 5: Software maintenance
	** [[/Refactoring/]]		** [[/Refactoring/]]
	* Ch. 6: Software configuration management
	** [[/Version Control/]]
	** [[/Version Numbers/]]
	** [[/Distribution/]]
	* Ch. 7: Software engineering management
	* Ch. 8: Software engineering process
	** [[/Software Development Methodology/]]
	*** [[/Iterative and Incremental Development/]]
	* Ch. 9: Software engineering models and methods
	* Ch. 10: Software quality
	* Ch. 11: Software engineering professional practice		* Ch. 11: Software engineering professional practice
	** [[/License/]]		** [[/License/]]

Andy Culbertson: Made minor changes to the topics intro, updated the SWEBOK download link, and added chapter numbers and placeholder topics.

2023-04-16T04:06:32Z

Made minor changes to the topics intro, updated the SWEBOK download link, and added chapter numbers and placeholder topics.

← Older revision		Revision as of 04:06, 16 April 2023
Line 33:		Line 33:
	== Topics ==		== Topics ==

	As a way to organize my notes and make sure I don't miss anything important, I'll use the structure of IEEE's ''Guide to the Software Engineering Body of Knowledge'' (SWEBOK). It's a standard that overviews the entire field and forms the basis for creating things like curricula and certifications. You can ~~download it for free~~ [https://www.computer.org/~~web~~/~~swebok~~/~~index as a~~ PDF] ~~or read it online [https://www.iso.org/obp/ui/#iso:std:iso-iec:tr:19759:ed-2:v2:en as HTML]~~.		As a way to organize my notes and make sure I don't miss anything important, I'll use the structure of IEEE's ''Guide to the Software Engineering Body of Knowledge'' (SWEBOK). It's a standard that overviews the entire field and forms the basis for creating things like curricula and certifications. You can [https://www.computer.org/education/bodies-of-knowledge/software-engineering/v3 download the PDF] for free.

	The items under the first level link to my notes on ~~those topics~~.		The items under the SWEBOK knowledge areas in the first level link to my notes on each topic.

	* Software requirements		* Ch. 1: Software requirements
	* Software design		** Requirements
	* Software construction		* Ch. 2: Software design
			** Design
			** Architecture
			** UX and UI
			* Ch. 3: Software construction
	** [[/Code Style/]]		** [[/Code Style/]]
	** [[/Project Structure/]]		** [[/Project Structure/]]
Line 55:		Line 59:
	** [[/Logging/]]		** [[/Logging/]]
	** [[/Test-First Programming/]]		** [[/Test-First Programming/]]
	* Software testing		* Ch. 4: Software testing
	** [[/Testing/]]		** [[/Testing/]]
	* Software maintenance		* Ch. 5: Software maintenance
	** [[/Refactoring/]]		** [[/Refactoring/]]
	* Software configuration management		* Ch. 6: Software configuration management
	** [[/Version Control/]]		** [[/Version Control/]]
	** [[/Version Numbers/]]		** [[/Version Numbers/]]
	** [[/Distribution/]]		** [[/Distribution/]]
	* Software engineering management		* Ch. 7: Software engineering management
	* Software engineering process		* Ch. 8: Software engineering process
	** [[/Software Development Methodology/]]		** [[/Software Development Methodology/]]
	*** [[/Iterative and Incremental Development/]]		*** [[/Iterative and Incremental Development/]]
	* Software engineering models and methods		* Ch. 9: Software engineering models and methods
	* Software quality		* Ch. 10: Software quality
	* Software engineering professional practice		* Ch. 11: Software engineering professional practice
	** [[/License/]]		** [[/License/]]
	* Software engineering economics		* Ch. 12: Software engineering economics
	* Computing foundations		* Ch. 13: Computing foundations
	* Mathematical foundations		* Ch. 14: Mathematical foundations
	* Engineering foundations		* Ch. 15: Engineering foundations

	== [[/Sources/]] ==		== [[/Sources/]] ==

Andy Culbertson: Moved the code examples and bibliography to a separate Sources article.

2019-02-23T22:44:26Z

Moved the code examples and bibliography to a separate Sources article.

@@ Line 18: / Line 18: @@
 This project consists of my reading other developers' advice, examining their code, deciding what to adopt and how to adapt it to my needs and preferences, and creating templates, procedures, reference materials, and anything else that might help me code well for a public user base.
 === Limitations ===
@@ Line 74: / Line 76: @@
 * Engineering foundations
-== Code examples ==
+== [[/Sources/]] ==
-Rosenfeld, Louis, Peter Morville, and Jorge Arango. ''Information Architecture: For the Web and Beyond''. Fourth edition. Sebastopol, CA: O’Reilly Media, Inc, 2015.
+See the article linked in the heading for a list of code examples and other sources I'm drawing from.
 <disqus/>

Andy Culbertson: Replaced the original outline of topics with one based on SWEBOK.

2019-02-23T22:38:27Z

Replaced the original outline of topics with one based on SWEBOK.

@@ Line 31: / Line 31: @@
 == Topics ==
-* [[/Software Development Methodology/]]
+As a way to organize my notes and make sure I don't miss anything important, I'll use the structure of IEEE's ''Guide to the Software Engineering Body of Knowledge'' (SWEBOK). It's a standard that overviews the entire field and forms the basis for creating things like curricula and certifications. You can download it for free [https://www.computer.org/web/swebok/index as a PDF] or read it online [https://www.iso.org/obp/ui/#iso:std:iso-iec:tr:19759:ed-2:v2:en as HTML].
-** [[/Iterative and Incremental Development/]]
 ** [[/Test-First Programming/]]
 ** [[/Refactoring/]]
-* [[/Version Control/]]
+* Software configuration management
-* [[/Code Style/]]
+** [[/Version Control/]]
 ** [[/Version Numbers/]]
 ** [[/License/]]
-* [[/Testing/]]
+* Software engineering economics
-* User Interface
+* Computing foundations
-** [[/Command Line Interface/]]
+* Mathematical foundations
-* [[/Documentation/]]
+* Engineering foundations
 == Code examples ==

Andy Culbertson: Added subheadings to the introduction. Added a purpose section. Updated some language to match the current project state.

2019-02-23T22:05:37Z

Added subheadings to the introduction. Added a purpose section. Updated some language to match the current project state.

← Older revision		Revision as of 22:05, 23 February 2019
Line 1:		Line 1:
	== Introduction ==		== Introduction ==

			=== Purpose ===

			This project is a growing set of notes on various aspects of software development. Its purpose is to define a set of standard operating procedures for my programming projects.

			=== Background ===

	For most of my coding life, I have been the only user of my programs. I wrote them to aid my work or personal life, and only rarely did anyone else even see my code or watch it run. This wasn't on purpose. It just turned out that way. In my current job I do belong to a small development team, but our programs are still only for in-house use, so the only needs we have to consider are our own.		For most of my coding life, I have been the only user of my programs. I wrote them to aid my work or personal life, and only rarely did anyone else even see my code or watch it run. This wasn't on purpose. It just turned out that way. In my current job I do belong to a small development team, but our programs are still only for in-house use, so the only needs we have to consider are our own.
Line 7:		Line 13:
	I haven't completely ignored these areas, though. I pick up on them here and there as I read about how other people code or as I see them in the software I use. Knowing that I'll probably need to know about them someday, I've kept a list. And now the time has come for me to fill in the details.		I haven't completely ignored these areas, though. I pick up on them here and there as I read about how other people code or as I see them in the software I use. Knowing that I'll probably need to know about them someday, I've kept a list. And now the time has come for me to fill in the details.

	I'm filling in the details here in this ~~guide~~ for two reasons. First, as I learn, writing helps me clarify my thoughts and keep them flowing. And second, posting my writing might help other people. So if you're like me and you've programmed mainly for yourself--what I call private coding--and you're starting to share your work with others--public coding--then maybe what I've learned so far can grease some of your own planning.		I'm filling in the details here in this project for two reasons. First, as I learn, writing helps me clarify my thoughts and keep them flowing. And second, posting my writing might help other people. So if you're like me and you've programmed mainly for yourself--what I call private coding--and you're starting to share your work with others--public coding--then maybe what I've learned so far can grease some of your own planning.

			=== Method ===

	This project consists of my reading other developers' advice, examining their code, deciding what to adopt and how to adapt it to my needs and preferences, and creating templates, procedures, reference materials, and anything else that might help me code well for a public user base.		This project consists of my reading other developers' advice, examining their code, deciding what to adopt and how to adapt it to my needs and preferences, and creating templates, procedures, reference materials, and anything else that might help me code well for a public user base.

			=== Limitations ===

	To give you an idea of my background, I've worked for the past 15 or so years in the publishing industry doing mostly text processing and some web development. The languages I'm most familiar with are Perl, Python, XSLT, and some JavaScript, with a smattering of PHP and VBA. I've spent almost all my time in Windows. I hope to branch out into at least Linux in the future, if only to expand my mind.		To give you an idea of my background, I've worked for the past 15 or so years in the publishing industry doing mostly text processing and some web development. The languages I'm most familiar with are Perl, Python, XSLT, and some JavaScript, with a smattering of PHP and VBA. I've spent almost all my time in Windows. I hope to branch out into at least Linux in the future, if only to expand my mind.

	This ~~guide~~ will be oriented toward Python for now, but I imagine a lot of its suggestions apply to other languages too. At this point it also centers around desktop command-line programs, but I'm hoping to expand it into other interfaces and environments.		This project will be oriented toward Python for now, but I imagine a lot of its suggestions apply to other languages too. At this point it also centers around desktop command-line programs, but I'm hoping to expand it into other interfaces and environments.

	~~Since this guide is a place for me to learn, I welcome feedback, and I'm always open to arguments that my choices could be improved or suggestions for things I've missed.~~		=== Feedback ===

	~~This~~ is ~~an early iteration of the guide~~, ~~so it's incomplete~~, and ~~a lot of it is only sketched out~~.		Since this project is a place for me to learn, I welcome feedback, and I'm always open to arguments that my choices could be improved or suggestions for things I've missed.

	== Topics ==		== Topics ==
Line 48:		Line 58:
	== Code examples ==		== Code examples ==

	To show how I'm implementing these ideas in my own code, I'll refer to [https://github.com/thinkulum my GitHub repositories] throughout the ~~guide~~, mainly my templates for [https://github.com/audreyr/cookiecutter cookiecutter], a Python app that creates project skeletons for any language, and my snippets for [https://www.sublimetext.com/ Sublime Text 2], the text editor I use. Snippets are templates Sublime inserts wherever you type the corresponding trigger strings.		To show how I'm implementing these ideas in my own code, I'll refer to [https://github.com/thinkulum my GitHub repositories] throughout the project, mainly my templates for [https://github.com/audreyr/cookiecutter cookiecutter], a Python app that creates project skeletons for any language, and my snippets for [https://www.sublimetext.com/ Sublime Text 2], the text editor I use. Snippets are templates Sublime inserts wherever you type the corresponding trigger strings.

	Here are projects that show up in lists of high quality code, so I'll examine some of them and include any relevant discoveries in the ~~guide~~. All the projects I'm listing for now are in Python.		Here are projects that show up in lists of high quality code, so I'll examine some of them and include any relevant discoveries in the project. All the projects I'm listing for now are in Python.

	* [https://launchpad.net/bzr Bazaar]		* [https://launchpad.net/bzr Bazaar]