From 67d717453ecd32c4e79c46162ad4fa5dd75e19c8 Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Tue, 16 Feb 2021 15:22:43 +0100 Subject: [PATCH 01/29] committing 1/3 of PRD --- README.md | 2 + product-requirements-document.md | 106 +++++++++++++++++++++++++++++++ 2 files changed, 108 insertions(+) create mode 100644 product-requirements-document.md diff --git a/README.md b/README.md index db27d7f3..d2aab537 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ This website is the homepage for the Foundation for Public Code. It is where we introduce and explain ourselves to the outside world, and invite readers into all the content that the Foundation for Public Code has to offer. +[Read the product requirements document](product-requirements-document.md) for our current audiences, goals and iteration plans for this website. + ## Installing This site is made for GitHub pages and thus runs their Jekyll install. diff --git a/product-requirements-document.md b/product-requirements-document.md new file mode 100644 index 00000000..655a88cc --- /dev/null +++ b/product-requirements-document.md @@ -0,0 +1,106 @@ +# Publiccode.net product requirements + +*Last updated: Feb 10, 2021* +*Initial creators: @elenafdr, @angelplasma* + +## Introduction + +We are building an increasingly dynamic hub of information, a living record of activity, and a beacon for international, public sector open-source collaboration, which will grow as a gateway to a rich and varied ecosystem of ideas, resources, and communities. + +This document gathers our previous learnings and experiences, as well as our desires and goals, into a central resource and idea hub for the evolution of [publiccode.net](https://publiccode.net). + +Publiccode.net must embody the [Foundation for Public Code communications principles](https://about.publiccode.net/activities/communication/communication-principles.html). + +## Audiences + +Publiccode.net is our front door for the world. As such, it serves a variety of audiences, but not all audiences are equally important to us. As a new membership organization, this is our current audience prioritization (as of summer 2020). + +### Higher priority + +* People at a public organization interested in membership +* People at public organizations who want to work with us (e.g. have a codebase or want to develop one in the open) +* People who want to support us philanthropically +* Journalists would like to tell the world about us + +### Mid-priority + +* People at a public organizationss who want to learn more or understand +* People who work at a related non-governmental organizations who want to work with us (like a think tank or academic research center) + +### Lower priority + +* General public +* Fans and casual contributors +* Potential staff + +Not prioritized for now + +* Current staff +* All other user groups listed in the [Value proposition hypotheses](https://about.publiccode.net/activities/value-and-impact/user-mapping/) + +## User stories + +These user stories center on actions a specific user wants to take when they visit our website. They do not include the information or tools we need to make available in order for the user to achieve their goal. + +### Higher priority users + +As an employee of a public organization interested in membership +I want to apply on behalf of my organization +So that we can be members + +As an employee of a public organization curious about membership +I want to explain the benefits of public code and membership to my colleagues +So that I can persuade them that our organization should join + +As an employee of or vendor to a public organization +I want to replicate a vetted public codebase +So that the organization can get a better outcome + +As someone who works on a public codebase +I want to find resources and community to support my codebase +So that my codebases can grow + +As someone with the resources to change the world +I want to change government technology by supporting public code +So that we make progress as a society + +As someone with the resources to change the world +I want to be able to understand the impact of my donation +So that I know what’s changed as a result + +As a journalist +I want have great source material about public code +So that I can produce an engaging and impactful story + +### Mid-priority + +As an employee of a public organization +I want to understand what the Foundation for Public Code does +So that I can decide if it’s relevant to my organization + +As an employee of a related non-governmental organization (like a think tank or academic research center) +I want to [see] + +### Lower priority + +As a fan of open source or public code +I want to know what the Foundation is up to +So I can get involved or spread the good news to other people + +As a fan of open source or public code +I want to understand how I can contribute to the Foundation +So that the Foundation’s mission succeeds + +As a brilliant person who needs to work +I want to understand what the Foundation does +So that I can decide if this is a good fit for my career ambitions + +As a brilliant person who needs to work +I want to apply for a job with the Foundation +So that I can do important work with awesome people + +As a member of the general public +I want to understand what the Foundation for Public Code does +So that I can feel more optimistic about technology and the future + + From e2dd57583f0ea25bbaa12f645643fb5d76d9472d Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Wed, 17 Feb 2021 17:55:03 +0100 Subject: [PATCH 02/29] Add new intro to user stories --- product-requirements-document.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index 655a88cc..02bcab6e 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -40,7 +40,10 @@ Not prioritized for now ## User stories -These user stories center on actions a specific user wants to take when they visit our website. They do not include the information or tools we need to make available in order for the user to achieve their goal. +These are representational user stories based on discussions and feedback we’ve received. +We believe these are the main goals of people who come to our website. + +If this doesn’t reflect your needs, please [raise an issue](https://github.com/publiccodenet/publiccode.net/issues) or [contact us](https://about.publiccode.net/organization/contact-details.html). ### Higher priority users From dcf112fa196e4eb87ef89e7c2463908ce4250628 Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Wed, 17 Feb 2021 18:20:40 +0100 Subject: [PATCH 03/29] user stories --- product-requirements-document.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/product-requirements-document.md b/product-requirements-document.md index 02bcab6e..c33d3769 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -106,4 +106,22 @@ As a member of the general public I want to understand what the Foundation for Public Code does So that I can feel more optimistic about technology and the future +## Goals + +In reference to the [Foundation for Public Code’s mission and goals](https://about.publiccode.net/organization/mission.html). + +1. Increase membership inquiries from potential member organizations. +2. Support reuse of codebases under stewardship by new public organizations. +3. Increase visibility of and downloads of the Standard, and include social proof of its increasingly widespread use. +4. Enable our community to make the case for public code to their colleagues, friends and family. +5. Establish our position as thought leaders with open source activists, government technology and digital transformation experts, other domain space influencers, political decision makers and philanthropists. +6. Grow traffic to key sections: Membership, Codebases, Codebase Stewardship, Background (or other equivalent fundamental explanations), Events and Communications calendar, Join us, and Standard for Public Code (and related marketing pages) +7. Increase site utilization: lower bounce rate, while increasing page depth and visit duration — overall, and specifically for intra-site page visits. +8. Become a beacon for open and transparent process. + +Goals made possible by a more intrusive analytics package than [Plausible]: + +* Increased international visitor spread, measured via decreased bounce rate from international audiences +* User journey tracking - how many visitors follow links featured on, for example, the pubilccode.net homepage +* Refining our content with the input (in numbers that translates into behaviours) of our visitors From d2ee588aefc72426d831dfe414071f3a43a5c06d Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Wed, 17 Feb 2021 22:36:04 +0100 Subject: [PATCH 04/29] Add actions --- product-requirements-document.md | 47 +++++++++++++++++++++++++------- 1 file changed, 37 insertions(+), 10 deletions(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index c33d3769..a90f7a56 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -33,7 +33,7 @@ Publiccode.net is our front door for the world. As such, it serves a variety of * Fans and casual contributors * Potential staff -Not prioritized for now +### Not prioritized for now * Current staff * All other user groups listed in the [Value proposition hypotheses](https://about.publiccode.net/activities/value-and-impact/user-mapping/) @@ -108,16 +108,23 @@ So that I can feel more optimistic about technology and the future ## Goals -In reference to the [Foundation for Public Code’s mission and goals](https://about.publiccode.net/organization/mission.html). +In reference to the [Foundation for Public Code’s mission and goals](https://about.publiccode.net/organization/mission.html). This is an unordered list. -1. Increase membership inquiries from potential member organizations. -2. Support reuse of codebases under stewardship by new public organizations. -3. Increase visibility of and downloads of the Standard, and include social proof of its increasingly widespread use. -4. Enable our community to make the case for public code to their colleagues, friends and family. -5. Establish our position as thought leaders with open source activists, government technology and digital transformation experts, other domain space influencers, political decision makers and philanthropists. -6. Grow traffic to key sections: Membership, Codebases, Codebase Stewardship, Background (or other equivalent fundamental explanations), Events and Communications calendar, Join us, and Standard for Public Code (and related marketing pages) -7. Increase site utilization: lower bounce rate, while increasing page depth and visit duration — overall, and specifically for intra-site page visits. -8. Become a beacon for open and transparent process. +A. Increase membership inquiries from potential member organizations. + +B. Support reuse of codebases under stewardship by new public organizations. + +C. Increase visibility of and downloads of the Standard, and include social proof of its increasingly widespread use. + +D. Enable our community to make the case for public code to their colleagues, friends and family. + +E. Establish our position as thought leaders with open source activists, government technology and digital transformation experts, other domain space influencers, political decision makers and philanthropists. + +F. Grow traffic to key sections: Membership, Codebases, Codebase Stewardship, Background (or other equivalent fundamental explanations), Events and Communications calendar, Join us, and Standard for Public Code (and related marketing pages) + +G. Increase site utilization: lower bounce rate, while increasing page depth and visit duration — overall, and specifically for intra-site page visits. + +H. Become a beacon for open and transparent process. Goals made possible by a more intrusive analytics package than [Plausible]: @@ -125,3 +132,23 @@ Goals made possible by a more intrusive analytics package than [Plausible]: * User journey tracking - how many visitors follow links featured on, for example, the pubilccode.net homepage * Refining our content with the input (in numbers that translates into behaviours) of our visitors +## Actions + +These are written in the format “To achieve this goal, we’ll try this intervention”. These are linked to the goals, but are not in priority order. + +A. To increase membership inquiries, we will showcase engagement by other (potential) members to lend us credibility, show testimonials from member orgs/codebases, and share success stories about codebases under stewardship. + +B. To support reuse of codebases under stewardship by new public organizations, we will make it easy to find basic information about the codebases, their functionality, their community, their maturity level and their potential. + +C. To increase visibility of the Standard, we will show where and how it’s in use, highlighting successes, and invite community building around the Standard. + +D. To enable our community to make the case for public code, we will provide a layman’s explanation of public code and the opportunities, backed by targeted evidence to help non-technology experts understand the advantages and disadvantages (for example, business cases for financial decision makers) + +E. To demonstrate our position as thought leaders, we will showcase our broader open source community engagement and participation, by showing who we share stages with, which publications/platforms we have access to, our high value press mentions and by quoting references to us in official documents. + +F. To grow traffic from the homepage, we’ll feature engaging content with clear calls to action and straightforward user journeys. + +G. To increase site utilization, we will tailor site content and architecture to better accommodate our various audiences, and use lightweight web analytics to see in detail where we are losing people, and what areas may benefit from more obvious navigability. + +H. To become a beacon for open and transparent processes, we will build upon the existing site’s idea of a seamless fusion between communication and tools, to continue informing our own process and culture, and publicly demonstrate the value of this way of working. + From d1453e110ea72f53df57201a1a910a882282cde0 Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Wed, 17 Feb 2021 22:39:45 +0100 Subject: [PATCH 05/29] Add Content types --- product-requirements-document.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/product-requirements-document.md b/product-requirements-document.md index a90f7a56..5aab401b 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -152,3 +152,21 @@ G. To increase site utilization, we will tailor site content and architecture to H. To become a beacon for open and transparent processes, we will build upon the existing site’s idea of a seamless fusion between communication and tools, to continue informing our own process and culture, and publicly demonstrate the value of this way of working. +## Content types on publiccode.net + +There are 2 types of content pages on publiccode.net: generic pages, which use the Foundation for [Public Code’s Jekyll theme] and may contain Liquid functionality, and custom pages, each characterized by their own layout, design and content. We have a bias toward the former, which are quick to create, low maintenance, and easy for less technically-experienced people to contribute to. + +### Generic pages + +* Individual staff biographies (like ) +* Section introduction page (index) (like ) +* Long form text (like or ) + +### Custom pages and page types + +* Homepage () +* Codebase stewardship explanation () +*Codebases index page (like publiccode.net/codebases/) +* Individual codebase overview (like ) +* Team index page (like ) +* Members and perhaps even a page about each member? [future] From c66cb3b806f0149c17bebf66d5483dea3aeaa848 Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Thu, 18 Feb 2021 00:24:14 +0100 Subject: [PATCH 06/29] All sections added, but still missing hyperlinks --- product-requirements-document.md | 79 ++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) diff --git a/product-requirements-document.md b/product-requirements-document.md index 5aab401b..c6ffbe65 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -170,3 +170,82 @@ There are 2 types of content pages on publiccode.net: generic pages, which use t * Individual codebase overview (like ) * Team index page (like ) * Members and perhaps even a page about each member? [future] + +## Technical and functional requirements + +### Technology and architecture + +* Open and public: Aim for 100% open-source and public domain languages and tools. Temporarily fall back on closed tools only when there is consensus on the benefits. +* Simpler and fewer: Use common and established tech whenever possible. For example, prefer CSS over SCSS, and avoid Javascript unless necessary. +* Easy expansion: Beautiful design should not interfere with or overly complexify the process of adding and editing content. Templatization and continued automatic ingestion of markdown is essential. +* Unified content, flexible display: Information display should be flexible, with few sources serving multiple endpoints. Continue to use Jekyll, Liquid and CSS media queries to enable one content set to serve multiple endpoints, including print/PDF. +* Rich content: Add abilities for embedded video, social and GitHub hooks + +## Experience + +* Presentation modes: Information should be accessible via desktop and mobile web browser, social media, email, and pdf (digital or print) +* Human accessible: [WCAG 2.1 Level A](https://www.w3.org/WAI/WCAG21/quickref/) (minimum). Accommodate the vision-impaired with screen-reader friendly, high contrast design. Avoid absolute text size units. Ensure proper keyboard-based navigability. +* Linguistically accessible: Speak to an international audience by using standard, non-colloquial English. Speak to a non-technical audience by avoiding jargon, or defining it when necessary and helpful. +* Technically accessible: Tools, languages and implementation style should prioritize procedures and code that is relatively easy to grasp and collaborate on. + +### Practices + +* Visible process: Bring tools and communication closer. Select for technologies which broadly facilitate viewing, insight, understanding, sharing and participation. +* Dogfood: Contribute to open source tools, practices and culture by avoiding closed/commercial platforms (even if they are arguably more powerful). +* Invite and reward feedback: Create and bond with collaborators by responding to their ideas, incorporating the good ones, and visibly crediting them. +* Document well: As the new site is built out of the old, align on agreed-upon best practices, and document these patterns as part of the process. Enable future collaborators (and forgetful selves) to understand why decisions were made. + +## Design Approach + +### Basic process + +* Gather initial ideas and goals from team via workshops +* Reference existing Github repos +* Assemble product requirements +* Create initial wireframes +* Present to team, board and public +* Refine wires and socialize until quorum reached +* Design and build site updates +* Review code, communication and design via standard Github process +* Test hypotheses +* Document +* Iterate + +### Concepts + +* Modular: Design with flexibility in mind, facilitating closer parity between organizational needs and website structure +* Transparent and Traversable: Keep communication connected to the work by using tools that blend them (like GitHub) and heavily using links to enable fluid traversal of the ecosystem +* Central and Extensible: While the site will be an increasingly capable hub of information, activity, and identity, it will perform best not as a self-contained, all-inclusive structure, but as a gateway to a rich and varied ecosystem of ideas, resources, and communities. It should be designed to share roles and responsibilities with other tools and efforts (like outreach, meetings, social media) + +### Voice + +* Optimistic, but cognizant of the challenges +* Earnest and open +* Not: Superior, ego-centric + +### Design language considerations + +* Informationally and functionally-focused. Flashy marketing moments have their place, but should be used minimally, and generally take a backseat to the real work of organization, collaboration and information. +* Machine and system-savvy, with a clear focus on the people impacted by the work +* Not: Computery as superficial visual motif +* Text-focused (but not ‘brutalist’ or abstracted) +* Future-looking (but not futuristic) and a bit timeless +* Synthesis of digital (process), architectural (physical civic infrastructure), and organic (humanity), to reflect the work’s central medium in its physical and human contexts +* Pops of color and purposeful photography of people and places can help bring it to life +* Imprintable. A neutral/monochromatic design foundation enables others to see themselves, their orgs and communities in our work. Heavy branding can interfere with this. +* Not: Generic, white-labelable +* Intimacy at scale. Bridge the gap between human scale and civic/global implications. +* Key elements can feature simple interactivity and animation, to bring the site subtly to life +* A simple symbol/color design language could be developed to assist in wayfinding, which also acts as a sort of functional branding + +### Design references + +* Floris’ excellent illustrations +* Illo.tv (Super approachable graphics, simple forms, given life through animation) +* Excellent API docs: Twilio, Stripe + +## References and sources + +* Publiccode.net user journeys workshop outputs (Aug 2020) +* Site Map + Wireframes in Figma +* Foundation for Public Code communications plan From 07412b1e919c5a5d1e18ab2dc1b80742df0b1250 Mon Sep 17 00:00:00 2001 From: angelplasma Date: Wed, 17 Feb 2021 22:48:01 -0800 Subject: [PATCH 07/29] Update product-requirements-document.md minor grammatical and formatting fixes --- product-requirements-document.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index c6ffbe65..53cb55b8 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -20,7 +20,7 @@ Publiccode.net is our front door for the world. As such, it serves a variety of * People at a public organization interested in membership * People at public organizations who want to work with us (e.g. have a codebase or want to develop one in the open) * People who want to support us philanthropically -* Journalists would like to tell the world about us +* Journalists who would like to tell the world about us ### Mid-priority @@ -181,7 +181,7 @@ There are 2 types of content pages on publiccode.net: generic pages, which use t * Unified content, flexible display: Information display should be flexible, with few sources serving multiple endpoints. Continue to use Jekyll, Liquid and CSS media queries to enable one content set to serve multiple endpoints, including print/PDF. * Rich content: Add abilities for embedded video, social and GitHub hooks -## Experience +### Experience * Presentation modes: Information should be accessible via desktop and mobile web browser, social media, email, and pdf (digital or print) * Human accessible: [WCAG 2.1 Level A](https://www.w3.org/WAI/WCAG21/quickref/) (minimum). Accommodate the vision-impaired with screen-reader friendly, high contrast design. Avoid absolute text size units. Ensure proper keyboard-based navigability. From fa603e11c4b5743ddae7a606bdfd248dc65bf3fc Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Thu, 18 Feb 2021 10:59:56 +0100 Subject: [PATCH 08/29] Add missing hyperlinks --- product-requirements-document.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index 53cb55b8..b86d77ca 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -126,7 +126,7 @@ G. Increase site utilization: lower bounce rate, while increasing page depth and H. Become a beacon for open and transparent process. -Goals made possible by a more intrusive analytics package than [Plausible]: +Goals made possible by a more intrusive analytics package than [Plausible](https://github.com/publiccodenet/about/pull/857): * Increased international visitor spread, measured via decreased bounce rate from international audiences * User journey tracking - how many visitors follow links featured on, for example, the pubilccode.net homepage @@ -154,7 +154,7 @@ H. To become a beacon for open and transparent processes, we will build upon the ## Content types on publiccode.net -There are 2 types of content pages on publiccode.net: generic pages, which use the Foundation for [Public Code’s Jekyll theme] and may contain Liquid functionality, and custom pages, each characterized by their own layout, design and content. We have a bias toward the former, which are quick to create, low maintenance, and easy for less technically-experienced people to contribute to. +There are 2 types of content pages on publiccode.net: generic pages, which use the [Foundation for Public Code’s Jekyll theme](https://github.com/publiccodenet/jekyll-theme/) and may contain Liquid functionality, and custom pages, each characterized by their own layout, design and content. We have a bias toward the former, which are quick to create, low maintenance, and easy for less technically-experienced people to contribute to. ### Generic pages @@ -191,7 +191,7 @@ There are 2 types of content pages on publiccode.net: generic pages, which use t ### Practices * Visible process: Bring tools and communication closer. Select for technologies which broadly facilitate viewing, insight, understanding, sharing and participation. -* Dogfood: Contribute to open source tools, practices and culture by avoiding closed/commercial platforms (even if they are arguably more powerful). +* [Dogfood](https://en.wikipedia.org/wiki/Eating_your_own_dog_food): Contribute to open source tools, practices and culture by avoiding closed/commercial platforms (even if they are arguably more powerful). * Invite and reward feedback: Create and bond with collaborators by responding to their ideas, incorporating the good ones, and visibly crediting them. * Document well: As the new site is built out of the old, align on agreed-upon best practices, and document these patterns as part of the process. Enable future collaborators (and forgetful selves) to understand why decisions were made. @@ -240,12 +240,12 @@ There are 2 types of content pages on publiccode.net: generic pages, which use t ### Design references -* Floris’ excellent illustrations -* Illo.tv (Super approachable graphics, simple forms, given life through animation) -* Excellent API docs: Twilio, Stripe +* [Illustrations.publiccode.net](https://illustrations.publiccode.net/) +* [Illo.tv](https://illo.tv) (Super approachable graphics, simple forms, given life through animation) +* Excellent API documentation: [Twilio](https://www.twilio.com/docs/usage/api), [Stripe](https://stripe.com/docs/api) ## References and sources -* Publiccode.net user journeys workshop outputs (Aug 2020) -* Site Map + Wireframes in Figma -* Foundation for Public Code communications plan +* [Publiccode.net user journeys workshop outputs](https://docs.google.com/spreadsheets/d/1Zk6DMSpF1eV_F7PATY679zNlCOSY8kE8Q8O1C9yhXT4/edit#gid=2067871141) (not shared publicly) (Aug 2020) +* [Site map and wireframes in Figma](https://www.figma.com/file/3KHjGMx7CvgX49VbZb0AFv/FPC-site?node-id=177%3A0) +* [Foundation for Public Code communications plan](https://about.publiccode.net/activities/communication/communications-plan.html) From 89afd24713f45162c3a82c52dd9d180019c20af7 Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Thu, 18 Feb 2021 11:03:19 +0100 Subject: [PATCH 09/29] update index CTA for PRD --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d2aab537..c2dcfc54 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This website is the homepage for the Foundation for Public Code. It is where we introduce and explain ourselves to the outside world, and invite readers into all the content that the Foundation for Public Code has to offer. -[Read the product requirements document](product-requirements-document.md) for our current audiences, goals and iteration plans for this website. +[Read the documentation](product-requirements-document.md) for our current audiences, goals and iteration plans for this website. ## Installing From f9117d5c06cf29c24686ff5e6c1eb0cb057990aa Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Thu, 18 Feb 2021 11:28:29 +0100 Subject: [PATCH 10/29] Missing NGO user story + linebreaks in user stories --- product-requirements-document.md | 58 ++++++++++++++++---------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index b86d77ca..a38c610f 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -47,63 +47,63 @@ If this doesn’t reflect your needs, please [raise an issue](https://github.com ### Higher priority users -As an employee of a public organization interested in membership -I want to apply on behalf of my organization +As an employee of a public organization interested in membership / +I want to apply on behalf of my organization / So that we can be members -As an employee of a public organization curious about membership -I want to explain the benefits of public code and membership to my colleagues -So that I can persuade them that our organization should join +As an employee of a public organization curious about membership / I want to explain the benefits of public code and membership to my colleagues / So that I can persuade them that our organization should join -As an employee of or vendor to a public organization -I want to replicate a vetted public codebase +As an employee of or vendor to a public organization / +I want to replicate a vetted public codebase / So that the organization can get a better outcome -As someone who works on a public codebase -I want to find resources and community to support my codebase +As someone who works on a public codebase / +I want to find resources and community to support my codebase / So that my codebases can grow -As someone with the resources to change the world -I want to change government technology by supporting public code +As someone with the resources to change the world / +I want to change government technology by supporting public code / So that we make progress as a society -As someone with the resources to change the world -I want to be able to understand the impact of my donation +As someone with the resources to change the world / +I want to be able to understand the impact of my donation / So that I know what’s changed as a result -As a journalist -I want have great source material about public code +As a journalist / +I want have great source material about public code / So that I can produce an engaging and impactful story ### Mid-priority -As an employee of a public organization -I want to understand what the Foundation for Public Code does +As an employee of a public organization / +I want to understand what the Foundation for Public Code does / So that I can decide if it’s relevant to my organization -As an employee of a related non-governmental organization (like a think tank or academic research center) -I want to [see] +As an employee of a related non-governmental organization / +I want to see high quality, meaningful work / +So that I can rely on the Foundation for Public Code in my own work / + ### Lower priority -As a fan of open source or public code -I want to know what the Foundation is up to +As a fan of open source or public code / +I want to know what the Foundation is up to / So I can get involved or spread the good news to other people -As a fan of open source or public code -I want to understand how I can contribute to the Foundation +As a fan of open source or public code / +I want to understand how I can contribute to the Foundation / So that the Foundation’s mission succeeds -As a brilliant person who needs to work -I want to understand what the Foundation does +As a brilliant person who needs to work / +I want to understand what the Foundation does / So that I can decide if this is a good fit for my career ambitions -As a brilliant person who needs to work -I want to apply for a job with the Foundation +As a brilliant person who needs to work / +I want to apply for a job with the Foundation / So that I can do important work with awesome people -As a member of the general public -I want to understand what the Foundation for Public Code does +As a member of the general public / +I want to understand what the Foundation for Public Code does / So that I can feel more optimistic about technology and the future ## Goals From fe25bbcd9c49491fb6996828ee4309df158f23fa Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Thu, 18 Feb 2021 11:35:29 +0100 Subject: [PATCH 11/29] fix broken links --- product-requirements-document.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index a38c610f..cafe886d 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -158,17 +158,17 @@ There are 2 types of content pages on publiccode.net: generic pages, which use t ### Generic pages -* Individual staff biographies (like ) -* Section introduction page (index) (like ) -* Long form text (like or ) +* Individual staff biographies (like [publiccode.net/who-we-are/team/alba-roza](/who-we-are/team/alba-roza.md)) +* Section introduction page (index) (like [publiccode.net/careers](/careers)) +* Long form text (like [publiccode.net/background](/background) or [publiccode.net/careers/intern](/careers/intern.md)) ### Custom pages and page types -* Homepage () -* Codebase stewardship explanation () -*Codebases index page (like publiccode.net/codebases/) -* Individual codebase overview (like ) -* Team index page (like ) +* Homepage ([publiccode.net(/index.html)) +* Codebase stewardship explanation ([publiccode.net/codebase-stewardship](/codebase-stewardship)) +* Codebases index page (like [publiccode.net/codebases/](/codebases)) +* Individual codebase overview (like [publiccode.net/codebases/signalen](/codebases/signalen.html)) +* Team index page (like [publiccode.net/who-we-are](/who-we-are)) * Members and perhaps even a page about each member? [future] ## Technical and functional requirements From 5299842fcc3c3aea07454e2c0e75831710f4a2d7 Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Thu, 18 Feb 2021 11:36:16 +0100 Subject: [PATCH 12/29] missing square bracket --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index cafe886d..334195e7 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -164,7 +164,7 @@ There are 2 types of content pages on publiccode.net: generic pages, which use t ### Custom pages and page types -* Homepage ([publiccode.net(/index.html)) +* Homepage ([publiccode.net](/index.html)) * Codebase stewardship explanation ([publiccode.net/codebase-stewardship](/codebase-stewardship)) * Codebases index page (like [publiccode.net/codebases/](/codebases)) * Individual codebase overview (like [publiccode.net/codebases/signalen](/codebases/signalen.html)) From a42a30214736a40ef6ca9241233bbf438a2fac0b Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Thu, 18 Feb 2021 11:37:18 +0100 Subject: [PATCH 13/29] typo --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index 334195e7..c3864115 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -129,7 +129,7 @@ H. Become a beacon for open and transparent process. Goals made possible by a more intrusive analytics package than [Plausible](https://github.com/publiccodenet/about/pull/857): * Increased international visitor spread, measured via decreased bounce rate from international audiences -* User journey tracking - how many visitors follow links featured on, for example, the pubilccode.net homepage +* User journey tracking - how many visitors follow links featured on, for example, the publiccode.net homepage * Refining our content with the input (in numbers that translates into behaviours) of our visitors ## Actions From 29c6b89d32e9bae51dbc0a24f424ecd208ce2362 Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Thu, 18 Feb 2021 11:38:19 +0100 Subject: [PATCH 14/29] typo --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index c3864115..85bced80 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -24,7 +24,7 @@ Publiccode.net is our front door for the world. As such, it serves a variety of ### Mid-priority -* People at a public organizationss who want to learn more or understand +* People at a public organizations who want to learn more or understand * People who work at a related non-governmental organizations who want to work with us (like a think tank or academic research center) ### Lower priority From 978e85202c4152480c0b15e91dafe0907aea9bf6 Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Thu, 18 Feb 2021 14:39:26 +0100 Subject: [PATCH 15/29] single line change --- product-requirements-document.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index 85bced80..5146901b 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -154,7 +154,12 @@ H. To become a beacon for open and transparent processes, we will build upon the ## Content types on publiccode.net -There are 2 types of content pages on publiccode.net: generic pages, which use the [Foundation for Public Code’s Jekyll theme](https://github.com/publiccodenet/jekyll-theme/) and may contain Liquid functionality, and custom pages, each characterized by their own layout, design and content. We have a bias toward the former, which are quick to create, low maintenance, and easy for less technically-experienced people to contribute to. +There are 2 types of content pages on publiccode.net: + +* generic pages, which use the [Foundation for Public Code’s Jekyll theme](https://github.com/publiccodenet/jekyll-theme/) and may contain Liquid functionality +* custom pages, each characterized by their own layout, design and content + +We have a bias toward the former, which are quick to create, low maintenance, and easy for less technically-experienced people to contribute to. ### Generic pages From 538ae05e35466b069c3798cb439c456a4d87bae9 Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Fri, 19 Feb 2021 09:39:44 +0100 Subject: [PATCH 16/29] space --- product-requirements-document.md | 1 - 1 file changed, 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index 5146901b..fe1b57d7 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -83,7 +83,6 @@ As an employee of a related non-governmental organization / I want to see high quality, meaningful work / So that I can rely on the Foundation for Public Code in my own work / - ### Lower priority As a fan of open source or public code / From f6121b5c63b2172b62b064fc125aa7249dd83143 Mon Sep 17 00:00:00 2001 From: Elena FdR Date: Fri, 10 Sep 2021 12:50:53 +0200 Subject: [PATCH 17/29] Update product-requirements-document.md Co-authored-by: Jan Ainali --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index fe1b57d7..fb037507 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -24,7 +24,7 @@ Publiccode.net is our front door for the world. As such, it serves a variety of ### Mid-priority -* People at a public organizations who want to learn more or understand +* People at public organizations who want to learn more or understand * People who work at a related non-governmental organizations who want to work with us (like a think tank or academic research center) ### Lower priority From 115a2c6ce2cae64554361f84048d02e218aee611 Mon Sep 17 00:00:00 2001 From: Elena FdR Date: Fri, 10 Sep 2021 12:51:05 +0200 Subject: [PATCH 18/29] Update product-requirements-document.md Co-authored-by: Jan Ainali --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index fb037507..45df96cc 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -25,7 +25,7 @@ Publiccode.net is our front door for the world. As such, it serves a variety of ### Mid-priority * People at public organizations who want to learn more or understand -* People who work at a related non-governmental organizations who want to work with us (like a think tank or academic research center) +* People who work at related non-governmental organizations who want to work with us (like a think tank or academic research center) ### Lower priority From 8127d9255d4598ad5f78e7b64a08c1ce6d5cb87c Mon Sep 17 00:00:00 2001 From: Elena FdR Date: Fri, 10 Sep 2021 12:51:17 +0200 Subject: [PATCH 19/29] Update product-requirements-document.md Co-authored-by: Jan Ainali --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index 45df96cc..8b079320 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -70,7 +70,7 @@ I want to be able to understand the impact of my donation / So that I know what’s changed as a result As a journalist / -I want have great source material about public code / +I want to have great source material about public code / So that I can produce an engaging and impactful story ### Mid-priority From 7f309d63f666d821bf62112e734bbc0ddce1f176 Mon Sep 17 00:00:00 2001 From: Elena FdR Date: Fri, 10 Sep 2021 12:51:52 +0200 Subject: [PATCH 20/29] Update product-requirements-document.md Co-authored-by: Jan Ainali --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index 8b079320..3d3c0291 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -204,7 +204,7 @@ We have a bias toward the former, which are quick to create, low maintenance, an ### Basic process * Gather initial ideas and goals from team via workshops -* Reference existing Github repos +* Reference existing GitHub repos * Assemble product requirements * Create initial wireframes * Present to team, board and public From 1f3db9b1af773eba4881c1a380cdc0449c5290de Mon Sep 17 00:00:00 2001 From: Elena FdR Date: Fri, 10 Sep 2021 12:52:00 +0200 Subject: [PATCH 21/29] Update product-requirements-document.md Co-authored-by: Jan Ainali --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index 3d3c0291..c526f01e 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -210,7 +210,7 @@ We have a bias toward the former, which are quick to create, low maintenance, an * Present to team, board and public * Refine wires and socialize until quorum reached * Design and build site updates -* Review code, communication and design via standard Github process +* Review code, communication and design via standard GitHub process * Test hypotheses * Document * Iterate From c6ddff6c343ac12bb38f5d839912bb9d0a90c7ad Mon Sep 17 00:00:00 2001 From: ElenaFdR Date: Fri, 10 Sep 2021 15:13:20 +0200 Subject: [PATCH 22/29] delinting --- product-requirements-document.md | 56 ++++++++++++++++---------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index c526f01e..765d2a80 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -47,62 +47,62 @@ If this doesn’t reflect your needs, please [raise an issue](https://github.com ### Higher priority users -As an employee of a public organization interested in membership / -I want to apply on behalf of my organization / +As an employee of a public organization interested in membership / +I want to apply on behalf of my organization / So that we can be members As an employee of a public organization curious about membership / I want to explain the benefits of public code and membership to my colleagues / So that I can persuade them that our organization should join -As an employee of or vendor to a public organization / -I want to replicate a vetted public codebase / +As an employee of or vendor to a public organization / +I want to replicate a vetted public codebase / So that the organization can get a better outcome -As someone who works on a public codebase / -I want to find resources and community to support my codebase / +As someone who works on a public codebase / +I want to find resources and community to support my codebase / So that my codebases can grow -As someone with the resources to change the world / -I want to change government technology by supporting public code / +As someone with the resources to change the world / +I want to change government technology by supporting public code / So that we make progress as a society -As someone with the resources to change the world / -I want to be able to understand the impact of my donation / +As someone with the resources to change the world / +I want to be able to understand the impact of my donation / So that I know what’s changed as a result -As a journalist / -I want to have great source material about public code / +As a journalist / +I want to have great source material about public code / So that I can produce an engaging and impactful story ### Mid-priority -As an employee of a public organization / -I want to understand what the Foundation for Public Code does / +As an employee of a public organization / +I want to understand what the Foundation for Public Code does / So that I can decide if it’s relevant to my organization -As an employee of a related non-governmental organization / -I want to see high quality, meaningful work / -So that I can rely on the Foundation for Public Code in my own work / +As an employee of a related non-governmental organization / +I want to see high quality, meaningful work / +So that I can rely on the Foundation for Public Code in my own work / ### Lower priority -As a fan of open source or public code / -I want to know what the Foundation is up to / +As a fan of open source or public code / +I want to know what the Foundation is up to / So I can get involved or spread the good news to other people -As a fan of open source or public code / -I want to understand how I can contribute to the Foundation / +As a fan of open source or public code / +I want to understand how I can contribute to the Foundation / So that the Foundation’s mission succeeds -As a brilliant person who needs to work / -I want to understand what the Foundation does / +As a brilliant person who needs to work / +I want to understand what the Foundation does / So that I can decide if this is a good fit for my career ambitions -As a brilliant person who needs to work / -I want to apply for a job with the Foundation / +As a brilliant person who needs to work / +I want to apply for a job with the Foundation / So that I can do important work with awesome people -As a member of the general public / -I want to understand what the Foundation for Public Code does / +As a member of the general public / +I want to understand what the Foundation for Public Code does / So that I can feel more optimistic about technology and the future ## Goals @@ -207,7 +207,7 @@ We have a bias toward the former, which are quick to create, low maintenance, an * Reference existing GitHub repos * Assemble product requirements * Create initial wireframes -* Present to team, board and public +* Present to team, board and public * Refine wires and socialize until quorum reached * Design and build site updates * Review code, communication and design via standard GitHub process From e8d9ab014881a1804b9cde6006cb1ad3ababc9cf Mon Sep 17 00:00:00 2001 From: claus Date: Tue, 14 Dec 2021 12:18:37 +0100 Subject: [PATCH 23/29] complete sentence stub --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index 765d2a80..a5bc774c 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -24,7 +24,7 @@ Publiccode.net is our front door for the world. As such, it serves a variety of ### Mid-priority -* People at public organizations who want to learn more or understand +* People at public organizations who want to learn more or understand what we do * People who work at related non-governmental organizations who want to work with us (like a think tank or academic research center) ### Lower priority From 279baefeca48521d486573241b32fb7aba4bdd1f Mon Sep 17 00:00:00 2001 From: claus Date: Tue, 14 Dec 2021 12:20:11 +0100 Subject: [PATCH 24/29] copy edit --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index a5bc774c..ce9a8bf6 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -49,7 +49,7 @@ If this doesn’t reflect your needs, please [raise an issue](https://github.com As an employee of a public organization interested in membership / I want to apply on behalf of my organization / -So that we can be members +So that we can be a member As an employee of a public organization curious about membership / I want to explain the benefits of public code and membership to my colleagues / So that I can persuade them that our organization should join From 58d7780b9b018a3a4bbf996a0c90c8d6b5da834f Mon Sep 17 00:00:00 2001 From: claus Date: Tue, 14 Dec 2021 12:21:01 +0100 Subject: [PATCH 25/29] clarify sentence --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index ce9a8bf6..949cee10 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -51,7 +51,7 @@ As an employee of a public organization interested in membership / I want to apply on behalf of my organization / So that we can be a member -As an employee of a public organization curious about membership / I want to explain the benefits of public code and membership to my colleagues / So that I can persuade them that our organization should join +As an employee of a public organization curious about membership / I want to explain the benefits of public code and membership to my colleagues / So that I can persuade them that our organization should join as a member As an employee of or vendor to a public organization / I want to replicate a vetted public codebase / From e64f33a10ba2abdc57bf3a1f676d0159a8595b98 Mon Sep 17 00:00:00 2001 From: claus Date: Tue, 14 Dec 2021 12:22:30 +0100 Subject: [PATCH 26/29] align style --- product-requirements-document.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index 949cee10..b4ce1b96 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -51,7 +51,9 @@ As an employee of a public organization interested in membership / I want to apply on behalf of my organization / So that we can be a member -As an employee of a public organization curious about membership / I want to explain the benefits of public code and membership to my colleagues / So that I can persuade them that our organization should join as a member +As an employee of a public organization curious about membership / +I want to explain the benefits of public code and membership to my colleagues / +So that I can persuade them that our organization should join as a member As an employee of or vendor to a public organization / I want to replicate a vetted public codebase / From a6e372937ab6309cc0cbd294427e7c4a933a75a7 Mon Sep 17 00:00:00 2001 From: claus Date: Tue, 14 Dec 2021 12:23:30 +0100 Subject: [PATCH 27/29] align style --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index b4ce1b96..d1fa95ae 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -83,7 +83,7 @@ So that I can decide if it’s relevant to my organization As an employee of a related non-governmental organization / I want to see high quality, meaningful work / -So that I can rely on the Foundation for Public Code in my own work / +So that I can rely on the Foundation for Public Code in my own work ### Lower priority From 41349f56e227e6e5728d52d1e2914f2fe2f8dc4f Mon Sep 17 00:00:00 2001 From: claus Date: Tue, 14 Dec 2021 12:25:58 +0100 Subject: [PATCH 28/29] write out abbreviation --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index d1fa95ae..cac9dbd9 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -137,7 +137,7 @@ Goals made possible by a more intrusive analytics package than [Plausible](https These are written in the format “To achieve this goal, we’ll try this intervention”. These are linked to the goals, but are not in priority order. -A. To increase membership inquiries, we will showcase engagement by other (potential) members to lend us credibility, show testimonials from member orgs/codebases, and share success stories about codebases under stewardship. +A. To increase membership inquiries, we will showcase engagement by other (potential) members to lend us credibility, show testimonials from member organizations and codebases, and share success stories about codebases under stewardship. B. To support reuse of codebases under stewardship by new public organizations, we will make it easy to find basic information about the codebases, their functionality, their community, their maturity level and their potential. From 52103833db99693774ffa56b8171a251b4ea3945 Mon Sep 17 00:00:00 2001 From: claus Date: Tue, 14 Dec 2021 12:32:27 +0100 Subject: [PATCH 29/29] abbreviation fix --- product-requirements-document.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product-requirements-document.md b/product-requirements-document.md index cac9dbd9..52d5cb79 100644 --- a/product-requirements-document.md +++ b/product-requirements-document.md @@ -238,7 +238,7 @@ We have a bias toward the former, which are quick to create, low maintenance, an * Future-looking (but not futuristic) and a bit timeless * Synthesis of digital (process), architectural (physical civic infrastructure), and organic (humanity), to reflect the work’s central medium in its physical and human contexts * Pops of color and purposeful photography of people and places can help bring it to life -* Imprintable. A neutral/monochromatic design foundation enables others to see themselves, their orgs and communities in our work. Heavy branding can interfere with this. +* Imprintable. A neutral/monochromatic design foundation enables others to see themselves, their organizations and communities in our work. Heavy branding can interfere with this. * Not: Generic, white-labelable * Intimacy at scale. Bridge the gap between human scale and civic/global implications. * Key elements can feature simple interactivity and animation, to bring the site subtly to life