about icon indicating copy to clipboard operation
about copied to clipboard

Add overview or executive summary for three target audiences

Open clausmullie opened this issue 5 years ago • 4 comments

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

Action point identified with @zorp and @bvhme

clausmullie avatar Oct 17 '19 15:10 clausmullie

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

Ainali avatar Oct 18 '19 07:10 Ainali

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

clausmullie avatar Oct 18 '19 08:10 clausmullie

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.

ElenaFdR avatar Oct 28 '19 10:10 ElenaFdR

Very well put Elena.

Also, the Standard is more of a framework, as @ericherman likes to say distilled from practice, where the About is the 'code' of our implementation/organization.

On Mon, 28 Oct 2019 at 11:38, Elena FdR [email protected] wrote:

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.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/publiccodenet/about/issues/1282?email_source=notifications&email_token=AAOUFPNWPPLAB5HEHNHDKELQQ26LJA5CNFSM4JB3OSY2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOECMNVYI#issuecomment-546888417, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAOUFPPXDX75N33UZ54BXKLQQ26LJANCNFSM4JB3OSYQ .

-- Boris van Hoytema, chief executive and secretary [email protected] – +31 20 2 444 555 – @bvhme

bvhme avatar Oct 28 '19 10:10 bvhme