Git Product home page Git Product logo

digitalgov-pra's Introduction

A Guide to the Paperwork Reduction Act

The PRA Guide is a plain language guide which answers the most common questions like, “What is the PRA for?”, “Do I need clearance?”, and “What’s the process?”

It aims to give federal employees confidence working with the PRA—and through this, lower the barriers to working effectively with the public.

Learn more at https://pra.digital.gov

About the site

  • This site uses Jekyll, a Ruby-based static site generator. For more information about using Jekyll, refer to the Jekyll documentation.

  • The site is built with the U.S. Web Design System, a set of reusable, high-quality components for modern websites.

  • The site is optimized for deployment on 18F's Federalist publishing service.

Running the site locally

After cloning the repo, install Jekyll and any necessary dependencies using:

npm install
bundle install

To run the site locally, from the project folder, run:

npm start

If you are missing fonts or images, install assets for local development with:

npm run build

If all goes well, visit the site at http://localhost:4000.

Accessibility tests

We follow the WCAG2AA standard, and one of the ways we check that we're following the right rules is through automated tools, like pa11y. For more info on the rules being tested checkout the pa11y wiki.

Running tests

To run a web accessibility test on digital.gov do the following:

  1. Install and run the site locally following the Running the site locally instructions above. Site must be running locally to perform the scan.
  • If this is your first time running pa11y, then you'll need to run npm install to make sure pa11ly is installed.
  1. In a separate terminal window, run npm run test:pa11y to initiate the accessibility checker.

Note: Accessibility testing configuration is located in the .pa11yci file.

Contributing

To provide feedback, follow this repository and open an issue in the repo.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

digitalgov-pra's People

Contributors

aalikaram avatar adborden avatar afeijoo avatar amandacostello avatar clmedders avatar cmajel avatar danraudonistc avatar dependabot[bot] avatar ecayer avatar hursey013 avatar jeremyzilar avatar jjediny avatar matthewbogdan avatar mejiaj avatar mmcmanusomb avatar nfraseromb avatar nick-mon1 avatar qhirschomb avatar qmanderson1 avatar saracope avatar smaromb avatar thisisdano avatar tonibonittogsa avatar wliberanteomb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

digitalgov-pra's Issues

Re-format Process Diagram

User comments:

  • Would want a horizontal timeline with an overall estimate of how long the overall process would take
  • not intuitive - wanted a count back clock

Align Bullets with Headings

In the Do I need clearance section bullets don’t align with the headings making it more difficult to find the information

Examples for different clearance types

Provide clear, real-life examples of when agencies choose one clearance type over another, and why it was appropriate. Added bonus if we can provide a decision tree / question set that helps users determine which clearance type is appropriate for them.

Proposed home under /clearance-types

Clarify OIRAs relationship to the PRA

We heard from users on both the contact and the home page that they were unclear about OIRA's relationship to the PRA.

We need to make sure users know that Desk Officers exist and they understand their role

Edit Punctuation

Make punctuation consistent throughout the site. Bulleted lists are especially inconsistently punctuated.

Add in Part A summary quesitons

This content is ready for the web: https://docs.google.com/document/d/1qqFMr9ZfGKIe2ZFx8UD2g9X6wR8YWnEgX876Asxhtlw/edit?usp=sharing

It's a plain language summary of the 18 questions in Part A of the supporting statement. Originally, it was made to be included at the bottom of the clearance-process/supporting-statement/

But that makes the page SO LONG!

Could this be another page in the approval process? A sub page under Supporting Statement (already a sub page)? Would love extra thoughts on this!

Add info about infosec rules/guidance

in the Burden Activities "Technology and Systems" h2, there was conversation about including info here about infosec rules/guidance. Decided to hold off for this launch, but a good candidate for Phase 2.

Also can connect to Chief Data Officer PRA responsibility update.

SSB Content

Plain language content explaining Supporting Statement B.

Suggested location: /clearance-process/supporting-statement/

Blank glossary term

I noticed today that if I click desk officer on the "Get help with the PRA" page, it calls the flyout but does not provide a definition.

Screen Shot 2019-04-16 at 3 43 41 PM

Add dropdown to PRA officer search

In the PRA officer search, currently a result is shown as you type. However, this could become confusing if a user's query matches multiple listings (eg. "Department").

Per this invision mockup, let's add a filtered dropdown that shows matching results as a user types.

The user can submit a query by:

  • clicking / entering on a item from the filtered list
  • Hitting enter on a query that does not have a matching listing.

Once a query is submitted, a listing result or a no result card will show.

Document how to add/remove subpages

We should provide a write up that includes:

  • how to add / remove sub pages within a section
  • how to find links that need to be updated
  • how to test your edits

Is the sidenav easy to use and understand?

A user should be able to use the sidenav to determine:

  • where they are
  • what other content exists on the page they are on
  • that there are separate, related pages they can navigate to

We have a few visual styles under consideration, and also have some open questions like:

  • How should current place be shown? What is most effective?
  • Do we need breadcrumbs / a section header?
  • Does the "overview" title work when it is different from the title of the page?

Clarify work related task

Work related task/duty clarification, this was a bit unclear to a user. An explanation and/or example is needed.

Add content around privacy

According to an OIRA desk officer:

There could be some niche situations where privacy is an issue even if no PII is collected.
We could point people in the direction of privacy experts at their agency.

Add basic style guide to wiki

Provide documentation on basic site styles and links to helpful resources like

  • USWDS basics
  • Accessibility basics
  • Color contrast checker

Provide training resources

Our top question during the design workshop was "Is there official PRA training?"

We should provide information about PRA training opportunities, both official and unofficial, on PRA.gov. Candidates include:

  • Contacting OIRA for a one-off training
  • Recording a "PRA primer" and hosting it on the site
  • Providing links to CAPRA training (e.g. the CAPRA conference)
  • ROCIS training

Proposed home as a subpage under /additional-resources/

Provide guidance on how to find examples of supporting statements and notices

Users asked for examples of the materials created during the Information Collection request process to understand what they will need to prepare and see examples of how others work. These resources are available online on the Federal Registrar and RegInfo.

The goals of this content would be users can find..:

  • Federal Registrar and RegInfo, and know how to search them
  • Examples of federal registrar notices for information collection requests
  • Completed ICRs via reginfo
  • Examples of various kinds of completed ICRs (statistical methodology, common forms, small scale forms)

Starter content here:
https://docs.google.com/document/d/10q4BU-5ls0XD1_4EcpB8ZOtw7gmXVvOXV36V8a2ieO4/edit#

Document how to link to relative pages

Something that has tripped us up a couple of times!

We should provide a place for the link syntax for adding a relative link to other pra.gov pages. Possibly we should have a "common syntax" section of the most commonly used syntax helpers.

Write out full terms where acronyms are seen first

  • On the homepage we use an acronym for OIRA in the first mention. It should be written out completely the first time.
  • On the "Do I need clearance?" page we write out Paperwork Reduction Act at the first mention.
  • In general, all acronyms should be written out in full at their first mention on each page.

Overall Process Completion Timeline

Users didn't get a clear view of the overall length of time the clearance process would take.
They also felt the current estimates (with the exception of the 30 day and 60 day public comment period) were inaccurate.

Could we check this part of burden estimates pls?

Two categories

  • Non-recurring or capital cost: one-time investments to fulfill a collection request
  • Recurring or annualized cost:

This doesn't match my understanding, so would be great to check this with one of our CAPRA experts.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.