|Material Type||Title||Overview||Courses||FOSS Area||Tags||Source|
|RPI CSCI-4961-01 Intro to Open Source||Software Engineering & Process||Coding & Style, Documentation, Tools & Communication|
|Reference||Rendered Language for Documentation||
Opensource.com article that describes the benefits for using a rendered language (not wikis) for documentation.
|CS0/Non-majors, CS1/CS2/Data Structures||Documentation||rendered language,||Opensource.com|
|Reference||Wikis for Documentation||
Opensource.com article describing how wikis can be used for FOSS project documentation.
|CS0/Non-majors, CS1/CS2/Data Structures, Data & Information Management||Culture/Intellectual Property, Documentation||wiki,||Opensource.com|
|Reference||Contributing to Open Source Documentation||
This blog presents a step-by-step approach for contributing documentation to a project on GitHub.
|CS0/Non-majors, CS1/CS2/Data Structures, Data & Information Management||Documentation||documentation, GitHub, how-to,||Andrew Chalkley|
|Reference||Mozilla Documentation Sprint How-To||
This is a guide to organizing a documentation sprint from Mozilla. It contains advice and tips from people who have organized doc sprints, to help you in organizing one, too.
|CS0/Non-majors, CS1/CS2/Data Structures, Data & Information Management||Documentation||documentation, how-to, sprint,||Mozilla|
|Reference||PHP Documentation Sprint||
This page reports on the results of a PHP Documentation Sprint.
|CS0/Non-majors, CS1/CS2/Data Structures, Data & Information Management, HCI UI/UX||Documentation||documentation, PHP, sprint,||Gingerling - phplist.org|
|Learning Activity||Drupal Documentation Sprint||
A Drupal “documentation sprint” means getting documentation writers together for a set amount of time – from a few hours to a few days usually – to write and edit documentation. This page contains information about how to set up and run such a sprint.
|CS0/Non-majors, CS1/CS2/Data Structures, Software Engineering & Process, System Architecture & Administration||Documentation||documentation, Drupal, how-to, sprint,||Drupal.org|
|Reference||Producing Open Source Software||
Producing Open Source Software is a book about the human side of open source development. It describes how successful projects operate, the expectations of users and developers, and the culture of free software. The book is released under an open copyright. You can buy it in bookstores, order copies from O’Reilly Media, or browse and download it here.
|Project Management, Software Engineering & Process||Coding & Style, Culture/Intellectual Property, Documentation, Philosophy/Politics, Product Packaging & Distribution, Quality & Testing, Specification & Design, Tools & Communication||Karl Fogel|
|Learning Activity||Code Review and Documentation in a C++ Repository on GitHub||
Students explore an open source project (QGIS, also known as Quantum GIS), hosted on GitHub, and answer a few questions about its meta-data. They are asked to read the implementation of its priority queue class, which has no documentation, and to write contract-style comments for the member functions in the interface file for that class.
|CS1/CS2/Data Structures||Coding & Style, Documentation||C++, code review, GitHub,||Stewart Weiss|
|Reference||11 ways to get involved in HFOSS||
11 ways to get involved in HFOSS
|CS0/Non-majors, CS1/CS2/Data Structures||Advocacy, Culture/Intellectual Property, Documentation, Introduction||Heather Leson / Open Health News|
|Learning Activity||Test Installation Instructions||
The goal of this activity is to test the correctness and completeness of the download and installation instructions for a FOSS project.
|CS0/Non-majors, CS1/CS2/Data Structures||Documentation, Quality & Testing, Use & Evaluate||install,||foss2serve.org|
|Learning Activity||UML a Project||
In this activity students will be assigned parts of an HFOSS project for which they will have to implement UML diagrams.
|CS1/CS2/Data Structures, Software Engineering & Process||Documentation, Specification & Design||HFOSS, UML,||foss2serve.org|
|Learning Activity||Document Code with Meaningful Comments||
In this POGIL activity students will define what “meaningful comments” mean and create a rubric for it. Then, they will create meaningful comments for a given source file with undocumented code.
|CS1/CS2/Data Structures||Coding & Style, Documentation||POGIL,||foss2serve.org|