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

Add overview or executive summary for three target audiences #1282

Open
clausmullie opened this issue Oct 17, 2019 · 4 comments
Open

Add overview or executive summary for three target audiences #1282

clausmullie opened this issue Oct 17, 2019 · 4 comments
Labels
enhancement New feature or request

Comments

@clausmullie
Copy link
Member

clausmullie commented Oct 17, 2019

Add overview or executive summary for the three target audiences (policy, management and developers/designers)

Action point identified with @zorp and @bvhme

@Ainali
Copy link
Member

Ainali commented Oct 18, 2019

Should we put that before the Table of contents or try to bake it into the introduction?

@clausmullie
Copy link
Member Author

The introduction is the part in the standard we haven't updated in quite some time.

The introduction currently introduces public code, stewardship and the standard, while the readers guide tells policy, management and developers/designers what they should do.

What we are missing is the opening 'hook' that explains to policy, management and developers/designers why this is important for them and what value it brings.

So I think our last thinking on this was a) that the current introduction of public code, stewardship and the standard could be moved somewhere else, keeping a shortened and hyperlinked version in the standard and b) we include targeted introductions including value propositions for the three audiences

@ElenaFdR
Copy link
Member

Re moving stewardship elsewhere:

  1. Right now the Standard stewardship content partially duplicates content we have on About, which will increase our maintenance burden as we update/evolve our understanding of stewardship. From a content debt perspective, it's better to have info in only one place and link to it from everywhere else.
  2. While the Standard is vital to how the Foundation approaches stewardship, it's perfectly possible to have Standard compliant code that has nothing to do with the Foundation - and arguably it's to our benefit to have the Standard applied far beyond our specific work. Rather than force our process on to everyone, I suggest we put everything about how we approach stewardship on the HTTP or About repos, and then link briefly from the Standard for anyone who's curious.

@bvhme
Copy link
Member

bvhme commented Oct 28, 2019 via email

@ElenaFdR ElenaFdR added the enhancement New feature or request label Jan 4, 2021
@ericherman ericherman transferred this issue from standard-for-public-code/standard-for-public-code Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants