INCF project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- INCF (International Neuroinformatics Coordinating Facility)
- Technical writer:
- Casper.dcl
- Project name:
- OpenWorm
- Project length:
- Standard length (3 months)
Project description
- Improve, refine, and amend up to 8-years-out-of-date documentation
- Create a new version of http://docs.openworm.org, including:
- Wiki
- Refocus around OpenWorm simulation stack (based on existing initial documentation), which has changed and been unified over the years
- Refocus around helping new volunteers run and improve existing code
- Write specs for casual contributions
- Reference special topics
- Papers in an OpenWorm special issue journal
- Educational materials such as OpenWorm badges
- Help refine a Mathematical overview of OpenWorm reference document
- Curate an inventory of projects and docs that align with current org goals
- Reorganise all project docs
- Tightly integrating/merging DevoWorm, NeuroML, Geppetto, and other assorted docs into one location
- Website redesign around finding key information
- People, how to get to Slack, GitHub, Docker, Blender models, etc.
- Help with the educational curriculum
- Docker containers and Jupyter notebooks
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["The OpenWorm project, a Google Season of Docs initiative, aims to revitalize the INCF's OpenWorm documentation by updating outdated content and creating a new version of docs.openworm.org."],["The project focuses on restructuring the documentation to support new volunteers in running and improving existing code, including specifications for casual contributions and a refocused simulation stack guide."],["Key deliverables include integrating various OpenWorm sub-projects' documentation, website redesign for improved information access, and support for educational curriculum development."],["The project leverages Docker containers and Jupyter notebooks to streamline the user experience."]]],["The core of this project involves updating and centralizing OpenWorm's documentation. Key actions include creating a new documentation version, refocusing it on the simulation stack, and aiding new volunteers. It also involves writing specs for casual contributions, curating a project inventory, reorganizing existing docs, and integrating various related documentations. A website redesign is planned to improve accessibility to information, and educational materials, such as Jupyter notebooks, will be developed.\n"]]
