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 DRAFTS - Adds & Revisions /wiki/spaces/AH/pages/3034480778 or Google Docs for editing and review.
...
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 DRAFTS - Adds & Revisions /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.
| Child pages (Children Display) | ||
|---|---|---|
|
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 Latest Reviews & Updates.
Reviews & Changes Process
Directly Responsible Individual’s (DRI) checklist for review/changing a process/guideline:
Demonstrate the reason for the change in the existing or new guideline process
Read and research relevant best practices
Document suggestions/concern points, using the #disc- Conversation Creator to help collect feedback. Inviting all relevant team members/stakeholders to share their suggestions in channel.
When the guideline change is applicable to all, then all the team members can be invited to join the disc-conversation channel, and wait for at least 2 weeks for everyone to share inputs, before finalizing the draft
Collate all the suggestions, and consider the suggestion which can be implemented within the given time/budget in hand. Create a Draft of the proposed guideline/process.
Ensure the values of the organization are considered while drafting the guideline/processes. The verbiage used must be kind, inclusive, and respectful.
When a monetary impact is expected from the suggested change in guideline/benefit - get a clear go-ahead from Ankur or Michael plus Puneet for ensuring the sustainability of the proposal.
Share the draft with the Relevant stakeholders with clear expectations, and clear deadlines by when you choose to close/publish the final draft.
Relevant stakeholders might be your direct team members and other leaders
Mention the change effective date
Post the deadline, and publish the draft to Confluence.
Go-live, announce via #announcement or #general channel using @team-axelerant / @channel tags
Share a video recap (Loom / Slack recorded video) if there’s too complex stuff that needs a simpler explanation of the process.
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.
...