Handbook Contributions

The most common incentive to create or edit documentation is to "scratch an itch," which is felt when we encounter a lack of information or standards around a practice. When you find a gap in the documentation, you're probably the best person to fill it. You’re encouraged to chat about your pending contribution in the #guild-handbook before creating a draft.

DRAFTS

When preparing to make changes to guidelines published in https://axelerant.atlassian.net/wiki/spaces/OA, create a copy of the target page in https://axelerant.atlassian.net/wiki/spaces/AH/pages/3034480778 or Google Docs for editing and review.

All drafts should be suffixed "DRAFT" in the page title. E.g., Benefits DRAFT. The draft version is to ensure that revisions are thought out and not perceived as rapid change.

When you’re confident DRAFT pages are good enough, submit a request to People Operations for editorial and legal review plus publishing.

When it’s time to publish the revision unless it’s a new page that can be directly moved, a designated person will copy the content from the https://axelerant.atlassian.net/wiki/spaces/AH/pages/3034480778 section page or Google Doc into the target page. We’ll not replace the page itself as to not break the page links.

Video https://www.loom.com/share/e659c78dd3014b18801863ba4c6b1bda

DRAFTS in Progress

The pages below are not publicly accessible, yet shared here at a high level to let you know the kinds of things we’re attempting to clarify well. When they go live, they’ll be brought into https://axelerant.atlassian.net/wiki/spaces/OA.

Unable to render {children}. We can't show you this information because you don't have access to the content.

Reviews

The @admin-team of People Operations handles editorial and legal review of Axelerant guidelines, policies, and processes within the Axelerant Handbook and Open Axelerant documentation once a year, typically every January.

Dates of https://axelerant.atlassian.net/wiki/spaces/OA/pages/1843724563.

Reviews & Changes Process

  • Each responsible stakeholder reads

    • Document concern points

    • Document go-live changes

  • Formalize go-live checklist

  • Execute go-live checklist

  • Go-live

  • Announce

  • Share video recap

  • Retrospect change

Page No Longer Fits - Archiving Content

When a page is no longer valuable to Axelerant, prepend the title with zzz and Archive it via the Confluence mechanism.