Software Engineering Practices for Scrum Updates #1#291
Conversation
…ng Practices guide
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://agreeable-island-0c966e810-291.centralus.6.azurestaticapps.net |
There was a problem hiding this comment.
Pull request overview
This pull request standardizes the reference formatting in the Software Engineering Practices guide by converting inline and URL-based citations to markdown footnote syntax, aligning with the academic reference format established in other guides like the Psychological Safety guide. The changes improve documentation maintainability and professional presentation.
Changes:
- Converted all in-text citations from
[N]to[^N]format and inline URLs to footnote references - Standardized list item punctuation by replacing colons/periods with dashes for consistency
- Updated the References section with proper academic formatting including italicized titles, proper punctuation, and access dates
|
|
||
| [^38]: Farley, D. (2022) _How to Design Better Software_ [Video]. YouTube. Available at: [https://youtu.be/8GONv6jJsG0](https://youtu.be/8GONv6jJsG0) (Accessed: 22 November 2025). | ||
|
|
||
| [^39]: Farley, D. (2022) _What Software Architecture Should Look Like?_ [Video]. YouTube. Available at: [https://youtu.be/ElMnHDSFaCw](https://youtu.be/ElMnHDSFaCw) (Accessed: 22 November 2025). |
There was a problem hiding this comment.
References [^36] (line 539) and [^39] (line 545) are duplicate entries pointing to the same video. The reference at line 370 using [^39] should either reuse [^36] or point to a different resource if a distinct citation was intended.
| [^39]: Farley, D. (2022) _What Software Architecture Should Look Like?_ [Video]. YouTube. Available at: [https://youtu.be/ElMnHDSFaCw](https://youtu.be/ElMnHDSFaCw) (Accessed: 22 November 2025). | |
| [^39]: Farley, D. (2022) _What Software Architecture Should Look Like?_ [Video]. YouTube. See reference [^36] for full bibliographic details. |
| [^6]: Wikipedia (2023) 'Coupling (computer programming)', _Wikipedia_. Available at: [https://en.wikipedia.org/wiki/Coupling_(computer_programming)](https://en.wikipedia.org/wiki/Coupling_(computer_programming)) (Accessed: 23 November 2025). | ||
|
|
||
| [7] Harvey, N. (2025) ‘DORA’s software delivery metrics: the four keys’. DORA. Available at: <https://dora.dev/guides/dora-metrics-four-keys/> (Accessed: 22 November 2025). | ||
| [^7]: Feynman, R. (no date) _The Pleasure of Finding Things Out_. Quoted in various works. |
There was a problem hiding this comment.
The reference for the Feynman quote lacks proper academic citation. "Quoted in various works" is too vague. Following the project's reference formatting standards, this should cite the specific source where this quote appears, such as "The Pleasure of Finding Things Out: The Best Short Works of Richard P. Feynman" (1999) or another specific publication with proper publication details including publisher and page numbers if available.
| [^7]: Feynman, R. (no date) _The Pleasure of Finding Things Out_. Quoted in various works. | |
| [^7]: Feynman, R.P. (1999) *The pleasure of finding things out: The best short works of Richard P. Feynman*. Cambridge, MA: Perseus Books. |
This pull request updates the
site/content/software-engineering-practices/2026.1/index.mdfile to improve the clarity and consistency of references throughout the document. The main focus is converting inline and URL-based references to use standardized markdown footnote syntax, ensuring a more professional and maintainable documentation style. Minor text and formatting improvements were also made for consistency and readability.Key changes include:
Reference and Citation Improvements:
[2]to[^2]), ensuring a consistent referencing approach throughout the document. [1] [2] [3] [4] [5] [6] [7]Formatting and Text Consistency:
Content Clarification:
These changes help make the document more professional, easier to navigate, and maintain, especially as references grow or change over time.
This change is