Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Translate leasons identified from code audits into common technical practices content #41

Open
andrewphilipsmith opened this issue Jun 16, 2022 · 0 comments
Labels
chapter Proposal for a chapter

Comments

@andrewphilipsmith
Copy link
Contributor

Summary

There are some useful generalisable lessons identified in from previous code audits, which are recorded on this page:
https://alan-turing-institute.github.io/REG-handbook/docs/how_we_work/code_audits/

Impact

It would be more helpful (and discoverable) if these were translated into technical guidance. However, this is not just a case of copy-and-paste into a different page. For example, this identifies a need:

"Installation is a big barrier for software with complex build requirements"

Providing good technical advice (even just pointing to good quality external advice) is non-trivial, but worthwhile.

Alternatives

There is no doubt very good third-party technical advice. This work should prioritise identifying and pointing to third-party technical advice where it exists, and only writing new content where there isn't 3rd party options.

Sections

Updates

@andrewphilipsmith andrewphilipsmith added the chapter Proposal for a chapter label Jun 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chapter Proposal for a chapter
Projects
None yet
Development

No branches or pull requests

1 participant