<commit_before>---
title: Google Season of Docs - Ideas list
subtitle: Want to get involved with Google Season of Docs? Here are a few ideas
lang: en
layout: page
---

# Information for Tech Writers 
First of all, welcome!

These ideas were contributed by our tech writers, developers and users. They
are sometimes vague or incomplete. If you wish to submit a proposal based on
these ideas, you may wish to contact the developers and find out more about the
particular suggestion you're looking at.

Being accepted as a Google Season of Docs tech writer is quite competitive.
Accepted candidates typically have thoroughly researched the technologies of
their proposed project and have been in frequent contact with potential
mentors. Simply copying and pasting an idea here will not work. On the other
hand, creating a completely new idea without first consulting potential mentors
is unlikely to work out.

When writing your proposal or asking for help from the general community of
Developers Italia don't assume everyone is familiar with the ideas here.

If there is no specific contact given you can ask questions on our
[Slack](https://slack.developers.italia.it/). You can get an invite
[here](https://slack.developers.italia.it/). If you don't know who your point
of contact should be, don't be shy, there is a channel called
[#welcome](https://developersitalia.slack.com/messages/C8U3ZSM5M) just for
this!

## Open ideas

Well prepared proposals from capable tech writers have an outstanding chance of
getting selected. We consider proposals for all skill levels ranging from
simple to crazy hard and everything in between. Introduce yourself, and we'll
help you plan one right for you.

Remember that project descriptions are just initial ideas. You must expand with
considerably more detail. Change the goals to fit your experience and
interests.

**Note for the community**.
Each project on the Ideas list should include:
1. a project title/description;
2. more detailed description of the project (2-5 sentences);
3. expected outcomes;
4. skills required/preferred;
5. possible mentors.

And, if possible, an *easy, medium or hard* rating of each project.


<table id="issues_table" class="display responsive dataTable no-footer dtr-inline" cellspacing="0" width="100%" role="grid" style="width: 100%;">
    <thead>
        <tr role="row">
            <th data-priority="2" tabindex="0" aria-controls="issues_table" rowspan="1" colspan="1" style="width: 40px;">Project</th>
            <th data-priority="0" tabindex="0" aria-controls="issues_table" rowspan="1" colspan="1" style="width: 400px;">Brief description</th>
            <th data-priority="11" class="sorting_disabled" rowspan="1" colspan="1" style="width: 30px;">Difficulty</th>
            <th data-priority="10" tabindex="0" aria-controls="issues_table" rowspan="1" colspan="1" style="width: 64px;">Contact</th>
        </tr>
    </thead>

    <tbody>
        <tr role="row" class="even" id="general">
            <td tabindex="0">General</td>
            <td>
                <b>Your own idea!!</b><br /> Something that you're totally
                excited about!<br />Do you have an awesome idea you want to
                work on with Developers Italia but that is not among the ideas
                below? That's cool. We love that! But please do us a
                favor: Get in touch with a mentor early on and make sure your
                project is realistic and within the scope of Developers Italia.
                That will spare you and us a lot of frustration.
                <br />
                <b>Mentor:</b> Propose your idea and ask who in Developers
                Italia is interested in what you want to work on and approach
                them. If you are unsure you can always ask in <a
                href="https://developersitalia.slack.com/messages/C8U3ZSM5M">#welcome</a>.
                <br />
                <b>Expected outcome:</b> To be discussed with your mentor...
                <br />
                <b>Required skills:</b>
                <ul>
                    <li>- Up to you :-)</li>
                </ul>
            </td>
            <td>Up to you</td>
            <td><a href="https://developersitalia.slack.com/messages/C8U3ZSM5M">#welcome</a></td>
        </tr>
        <tr role="row" class="even" id="pdnd-general-docs">
            <td tabindex="0">PDND Technical Documentation</td>
            <td>
                The <b>PDND</b> (formerly Data and Analytics Framework) is under active development,
                and the <a href="https://docs.italia.it/italia/daf/daf-docs/">original technical documentation</a> is now outdated and needs a review.
                <br />
                <b>Mentor:</b> developers and devops involved in PDND development, you can start asking in slack <a
                href="https://developersitalia.slack.com/messages/C760XQX9Q">#daf</a> channel.
                <br />
                <b>Expected outcome:</b> An upgraded version of <a href="https://docs.italia.it/italia/daf/daf-docs/">https://docs.italia.it/italia/daf/daf-docs/</a>.
                <br />
                <b>Required skills:</b>
                <ul>
                    <li>- Micro services architecture</li>
                    <li>- Docker, Kubernetes, Terraform</li>
                </ul>
            </td>
            <td>Hard</td>
            <td><a href="https://developersitalia.slack.com/messages/C760XQX9Q">#daf</a></td>
        </tr>
</tbody>
</table><commit_msg>Add GSoD idea: PDND Dataportal user documentation<commit_after>---
title: Google Season of Docs - Ideas list
subtitle: Want to get involved with Google Season of Docs? Here are a few ideas
lang: en
layout: page
---

# Information for Tech Writers 
First of all, welcome!

These ideas were contributed by our tech writers, developers and users. They
are sometimes vague or incomplete. If you wish to submit a proposal based on
these ideas, you may wish to contact the developers and find out more about the
particular suggestion you're looking at.

Being accepted as a Google Season of Docs tech writer is quite competitive.
Accepted candidates typically have thoroughly researched the technologies of
their proposed project and have been in frequent contact with potential
mentors. Simply copying and pasting an idea here will not work. On the other
hand, creating a completely new idea without first consulting potential mentors
is unlikely to work out.

When writing your proposal or asking for help from the general community of
Developers Italia don't assume everyone is familiar with the ideas here.

If there is no specific contact given you can ask questions on our
[Slack](https://slack.developers.italia.it/). You can get an invite
[here](https://slack.developers.italia.it/). If you don't know who your point
of contact should be, don't be shy, there is a channel called
[#welcome](https://developersitalia.slack.com/messages/C8U3ZSM5M) just for
this!

## Open ideas

Well prepared proposals from capable tech writers have an outstanding chance of
getting selected. We consider proposals for all skill levels ranging from
simple to crazy hard and everything in between. Introduce yourself, and we'll
help you plan one right for you.

Remember that project descriptions are just initial ideas. You must expand with
considerably more detail. Change the goals to fit your experience and
interests.

**Note for the community**.
Each project on the Ideas list should include:
1. a project title/description;
2. more detailed description of the project (2-5 sentences);
3. expected outcomes;
4. skills required/preferred;
5. possible mentors.

And, if possible, an *easy, medium or hard* rating of each project.


<table id="issues_table" class="display responsive dataTable no-footer dtr-inline" cellspacing="0" width="100%" role="grid" style="width: 100%;">
    <thead>
        <tr role="row">
            <th data-priority="2" tabindex="0" aria-controls="issues_table" rowspan="1" colspan="1" style="width: 40px;">Project</th>
            <th data-priority="0" tabindex="0" aria-controls="issues_table" rowspan="1" colspan="1" style="width: 400px;">Brief description</th>
            <th data-priority="11" class="sorting_disabled" rowspan="1" colspan="1" style="width: 30px;">Difficulty</th>
            <th data-priority="10" tabindex="0" aria-controls="issues_table" rowspan="1" colspan="1" style="width: 64px;">Contact</th>
        </tr>
    </thead>

    <tbody>
        <tr role="row" class="even" id="general">
            <td tabindex="0">General</td>
            <td>
                <b>Your own idea!!</b><br /> Something that you're totally
                excited about!<br />Do you have an awesome idea you want to
                work on with Developers Italia but that is not among the ideas
                below? That's cool. We love that! But please do us a
                favor: Get in touch with a mentor early on and make sure your
                project is realistic and within the scope of Developers Italia.
                That will spare you and us a lot of frustration.
                <br />
                <b>Mentor:</b> Propose your idea and ask who in Developers
                Italia is interested in what you want to work on and approach
                them. If you are unsure you can always ask in <a
                href="https://developersitalia.slack.com/messages/C8U3ZSM5M">#welcome</a>.
                <br />
                <b>Expected outcome:</b> To be discussed with your mentor...
                <br />
                <b>Required skills:</b>
                <ul>
                    <li>- Up to you :-)</li>
                </ul>
            </td>
            <td>Up to you</td>
            <td><a href="https://developersitalia.slack.com/messages/C8U3ZSM5M">#welcome</a></td>
        </tr>
        <tr role="row" class="even" id="pdnd-general-docs">
            <td tabindex="0">PDND Technical Documentation</td>
            <td>
                The <b>PDND</b> (formerly Data and Analytics Framework) is under active development,
                and the <a href="https://docs.italia.it/italia/daf/daf-docs/">original technical documentation</a> is now outdated and needs a review.
                <br />
                <b>Mentor:</b> developers and devops involved in PDND development, you can start asking in slack <a
                href="https://developersitalia.slack.com/messages/C760XQX9Q">#daf</a> channel.
                <br />
                <b>Expected outcome:</b> An upgraded version of <a href="https://docs.italia.it/italia/daf/daf-docs/">https://docs.italia.it/italia/daf/daf-docs/</a>.
                <br />
                <b>Required skills:</b>
                <ul>
                    <li>- Micro services architecture</li>
                    <li>- Docker, Kubernetes, Terraform</li>
                </ul>
            </td>
            <td>Hard</td>
            <td><a href="https://developersitalia.slack.com/messages/C760XQX9Q">#daf</a></td>
        </tr>
        <tr role="row" class="even" id="pdnd-dataportal-tutorial">
            <td tabindex="0">PDND Dataportal Tutorial</td>
            <td>
                The <b>PDND</b> (formerly Data and Analytics Framework) has a <a href="https://dataportal.daf.teamdigitale.it/#/">frontend website</a> for general users who search for open data from public administrations. It needs documentation and tutorials to ease the user journey from general question to the proper dataset.
                <br />
                <b>Mentor:</b> developers involved in PDND Dataportal development, you can start asking in slack <a
                href="https://developersitalia.slack.com/messages/C9W38TN3H">#daf-dataportal</a> channel.
                <br />
                <b>Expected outcome:</b> An approachable user documentation with tutorials (ie. text with images, infographics, comics, and so on).
                <br />
                <b>Required skills:</b>
                <ul>
                    <li>- Graphic skills are valued</li>
                </ul>
            </td>
            <td>Hard</td>
            <td><a href="https://developersitalia.slack.com/messages/C9W38TN3H">#daf-dataportal</a></td>
        </tr>
</tbody>
</table>
{'fraction_non_alphanumeric': 0.10495081700674742, 'fraction_numerical': 0.010324363872855865, 'mean_word_length': 2.5118469882957464, 'pattern_counts': {'":': 0, '<': 198, '<?xml version=': 0, '>': 198, 'https://': 23, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '319392', 'n_tokens_mistral': 3548, 'n_tokens_neox': 3305, 'n_words': 1296}