18F Getting Started: Modernizing Government Digital Services

Getting started overview

18F, a part of the U.S. General Services Administration (GSA), functions as a digital services consultancy that assists federal agencies in building and buying technology. Unlike commercial API providers, 18F does not offer a public API product that requires external signup or API keys. Instead, 'getting started' with 18F involves understanding their operational model, accessing their extensive guides and playbooks, and engaging with their open-source projects or directly with their teams for internal government initiatives.

Their mission is to improve the government's digital services by advocating for agile development, user-centered design, and open-source solutions. For federal employees and contractors, this means leveraging 18F's comprehensive guides and resources to implement modern development practices within their own projects. For those outside the federal government, understanding 18F's approach can provide insights into best practices for public sector digital transformation and API strategy, which often aligns with general enterprise best practices for cloud and API governance.

The primary steps to 'get started' with 18F focus on familiarization and application of their principles. This process typically includes:

1. Understanding 18F's Mission and Services: Reviewing their official website to grasp their role within the government.
2. Accessing Documentation: Exploring their guides, playbooks, and blog posts for practical advice on digital projects.
3. Engaging with Open Source: Examining and contributing to their public repositories on platforms like GitHub.
4. Internal Collaboration (for government agencies): Initiating contact for direct project support or partnership.

This guide will detail how to navigate these engagement points, focusing on accessing their knowledge base and understanding the pathways for collaboration within the federal ecosystem.

Create an account and get keys

As an internal government consultancy, 18F does not require a public account creation process or issue API keys for external developers. Their services are primarily delivered through direct consultation with federal agencies and by making their methodologies and tools publicly available. Therefore, there is no 'signup' in the traditional sense for external users seeking an API key.

If you are a federal employee or contractor looking to engage 18F for a project, the process involves internal government procedures rather than a web-based signup form. Typically, this begins with reviewing 18F's guidance for agencies on how to work with them. This section on their website provides details on how to initiate contact and what to expect during a collaborative engagement.

Key points regarding 'accounts' and 'keys' for 18F:

• No Public API Keys: 18F does not provide API keys for accessing external services, as they do not offer a public-facing API product.
• No Public Account Creation: There is no registration portal for non-government entities to create an account directly with 18F.
• Internal Engagement for Agencies: Federal agencies seeking 18F's assistance follow a structured internal process, often starting with an inquiry to the 18F team via official government channels.
• Accessing Resources: All of 18F's guides, playbooks, and open-source code repositories are publicly accessible without an account or keys. These resources are designed to be self-service for anyone interested in applying their digital transformation principles.

The focus for 'getting started' is on consuming their intellectual output and understanding their operational model rather than on technical authentication for a service.

Your first request

Since 18F does not offer a public API, the concept of making a 'first request' in the traditional sense (e.g., an HTTP API call with an API key) does not apply. Instead, a 'first request' with 18F can be interpreted as your initial interaction with their publicly available knowledge base or open-source projects. This involves accessing their documentation or cloning one of their public repositories.

Accessing 18F Documentation

The most common and immediate 'first request' for anyone interested in 18F's work is to explore their official documentation. This serves as your primary interface with their methodologies and insights.

Step 1: Navigate to the 18F Guides

Open your web browser and go to the 18F Guides page. This central hub contains various playbooks, handbooks, and articles covering topics from agile development to procurement and cloud native strategies.

Step 2: Select a Guide of Interest

Choose a guide relevant to your interests. For example, the 18F Agile Methods Matchup Guide provides an overview of different agile methodologies and their applicability. Reading through these guides constitutes your 'first request' for information, as you are directly accessing their intellectual output.

Engaging with 18F Open Source Projects

For developers, a 'first request' might involve interacting with one of 18F's many open-source projects. These projects are typically hosted on GitHub.

Step 1: Visit 18F's GitHub Organization

Navigate to the 18F GitHub organization page. This page lists numerous repositories maintained by 18F teams.

Step 2: Choose a Repository to Explore

Select a repository that aligns with your technical interests. For instance, you might explore a project like api.data.gov, which provides a centralized API management service for federal agencies. This project itself offers APIs, but these are for other government agencies and typically use internal authentication mechanisms, not public API keys from 18F itself.

Step 3: Clone the Repository (Optional)

To make a more direct 'request' in a development context, you can clone a repository to your local machine. For example, using Git:

git clone https://github.com/18F/api.data.gov.git
cd api.data.gov

This action represents your first direct interaction with 18F's codebase, allowing you to inspect the code, run local tests (if applicable), and potentially contribute. This is analogous to making a 'first request' to an API in that you are initiating a structured interaction with their technical output.

Summary Table: Your First Interaction with 18F

Common next steps

After familiarizing yourself with 18F's resources and potentially exploring their open-source projects, common next steps depend on whether you are a government agency seeking collaboration or an external party interested in their methodologies.

For Federal Agencies and Government Contractors:

1. Initiate Contact for Project Support: If your agency requires direct assistance with a digital project, review the 18F guidance on how to work with them. This typically involves submitting an inquiry to discuss your project needs and potential engagement models.
2. Adopt 18F Playbooks: Implement the principles and practices outlined in 18F's various playbooks, such as the Digital Services Playbook, within your own agency's projects. These resources provide practical steps for agile development, user research, and modern procurement.
3. Leverage Open-Source Tools: Integrate specific 18F-developed open-source tools or frameworks into your agency's technology stack where appropriate. Many of their projects are designed for reuse across government.
4. Participate in Training and Workshops: Look for opportunities to participate in 18F-led training sessions or workshops focused on agile development, cloud adoption, or API strategy.

For External Parties (Academics, Industry, General Public):

1. Deep Dive into Specific Guides: Explore 18F's guides and playbooks in more detail, focusing on areas like API management best practices, cloud migration strategies, or user-centered design principles. These provide valuable insights into modern government technology.
2. Monitor 18F Blog and Updates: Stay informed about new initiatives, projects, and insights by following the 18F blog and their official social media channels.
3. Contribute to Open Source: For developers, consider contributing to 18F's open-source projects on GitHub. This can involve submitting bug reports, proposing features, or contributing code, aligning with the principles of open government and collaboration.
4. Learn from Case Studies: Analyze 18F's case studies and project summaries to understand how they approach and solve complex government technology challenges. This can inform your own work or research.

The overarching goal for both internal and external stakeholders is to either directly collaborate on improving government digital services or to learn from and apply 18F's proven methodologies.

Troubleshooting the first call

Given that 18F does not provide a traditional public API requiring authentication or direct calls, 'troubleshooting the first call' takes on a different meaning. Instead of debugging HTTP requests, it focuses on resolving issues related to accessing their resources or understanding their guidance.

Common 'Troubleshooting' Scenarios:

• Issue: Cannot find specific documentation or guide.
  • Solution: Use the search function on the 18F Guides page or the main 18F website. Ensure your search terms are precise. Sometimes, older content might be archived or integrated into newer guides.
• Issue: Difficulty understanding an 18F concept or methodology.
  • Solution: Many 18F guides include glossaries or links to foundational concepts. For deeper understanding, consult the 18F blog for articles that often elaborate on specific topics. Additionally, external resources on agile, user-centered design, or cloud computing can provide supplementary context.
• Issue: Open-source project on GitHub is not working as expected.
  • Solution:
    1. Check README: Thoroughly read the README.md file in the project's GitHub repository for setup instructions, prerequisites, and common issues.
    2. Review Issues: Look at the 'Issues' tab on the GitHub repository to see if others have reported similar problems and if solutions or workarounds are available.
    3. Check Dependencies: Ensure all project dependencies are correctly installed and meet the specified versions.
    4. Open an Issue: If you've exhausted other options, consider opening a new issue on the GitHub repository, providing clear steps to reproduce the problem and details about your environment. This is the primary channel for technical support on 18F's open-source projects.
• Issue: As a government agency, how do I engage 18F directly for project support?
  • Solution: Refer to the 'How to work with 18F' guide on their website. This page outlines the process for federal agencies to initiate collaboration, including contact information and preliminary steps. It's crucial to follow the official internal channels rather than attempting to engage through public comments or issues on GitHub for direct project work.

Effective 'troubleshooting' with 18F primarily involves diligent use of their comprehensive online resources and adhering to established communication channels for specific types of engagement. Their commitment to transparency means most information is publicly available and well-documented.