---
# System prepended metadata

title: Google Season of Docs 2024 - NetworkManager

---

# Google Season of Docs 2024 - NetworkManager

## Proposal title

Create user story based NetworkManager documentation

## About your organization

NetworkManager is the standard Linux network configuration tool suite. It supports large range of networking setups, from desktop to servers and mobile and integrates well with popular desktop environments and server configuration management tools.

## About your project

The NetworkManager developers also support a list of clients like nmcli, keyfile, Network System Roles and Nmstate. In general, the setting properties are documented but the project is lacking specific documentation for common user stories.

Creating public documentation following the user story formatting is a really nice thing to have for end users. The user can easily understand what they need to do for getting a specific outcome.

## Your project's scope

Project's goal:
1. Collaborate with the developers of NetworkManager and the related projects to get a pool of common user stories.

2. Create structured documentation of how to accomplish the scenario described in the user stories with the following NetworkManager clients.
    1. keyfiles
    2. nmcli
    3. Network System Roles
    4. Nmstate

3. Publish the documentation in the official project website.

## Measuring your project's success

The new user story based documentation is available in the NetworkManager official project website. There are multiple links or tabs to select the specific client documentation for each user story.

## Timeline

May

The writer will receive guidance on navigating onboarding documentation. At the end of this phase, the write will have a good understanding of NetworkManager project scope and its clients.

June - July

The writer will work with the NetworkManager developers in order to collect the most useful user stories. They will work with NetworkManager product owner to refine them and make sure they are correct and make sense.

August - October

The writer will work on the documentation needed based on the user stories compiled. The NetworkManager developers will collaborate reviewing and publishing the documentation.

November

Wrapping up the project completion.

## Additional information

Previous experience with technical writers or documentation: The NetworkManager team have work with technical writers before.

Workflow:
The documentation generated will be added in a form of MR to the project repository. Once merged, the website is regenerated and the new content will be published.

Recommended Docs Tooling:
Text editor, Git, Command Line Interface, Linux environment and markdown