Open Source Software Resources

Chris Jensen and Walt Scacchi

 

Version 1.1

November 2004

 

 

Community Infrastructure resources

    Communication

        Media

            Point to point

                Chat/IRC transcript archives
                Threaded email discussion archives
                Discussion group archives
                Forum message archives
                Newsgroup archives
                Listserv archives

           Non-point to point

                Community digests (e.g. kernel cousins)
                Online journal/Weblog (blog) archives
                Wiki change archives
                Module/Community web pages, web content management archives

        Artifacts

            Community announcements

                Upgrade notes/instructions
                Changelogs
                Module/community  news/newsletters
                Patch lists

    Coordination

        Role descriptions/How to contribute guides



Community Documentation Artifacts

    Community interaction guides

        Generic/non-role specific

            Tutorials/Guides

                    Site map
                    Communication
                        Mailing list, chat participation guides
                    FAQs
                        Module/Project
                        Source License
                        Role based FAQs

                            Community manager

                            Foundation member

                            Board member

            Project handbook

            Knowledge Bases

            Articles

                   Recommended reading
                    Community history

        User

            Contribution tutorials/ guides

                    Article contribution
                        Usage reports
                        Press kits
                    Defect report/RFC submission

        Developer

            Tutorials/Guides/FAQs

                    Communication
                        News/newsletter contribution
                        Community digest contribution
                    FAQs
                        Web author
                        Board member responsibilities
                        Community manager responsibilities

        3rd party/External relations

            Development contributor

            Financial contributor

            Legal contributor

    Product infrastructure

        Non-activity specific

            Reports

                   Whitepapers

            Module catalog

        Development

            Tutorials/guides/FAQs

                    Process activity FAQs
                        Building/compiling the sources
                        Debugging the sources
                        Code review
                    Role based FAQs
                        Code sheriff
                        Developer
                        Tester
                        Source repository manager
                        Module leader
                        Release manager
                    Process Activity Guides
                        Compilation
                        Source repository interaction

                            Checkout

                            Obtain checkin access

                            Checkin, merge

                        Database access guide

            Guidelines

                    Source editing (who, when, what, where)
                    Source formatting
                    Documentation formatting
                    User interface
                    Defect/Issue priority guidelines
                    Web artifact formatting
                    Documentation conventions

            Reports

                    Build reports
                    Defect/Issue reports
                        Defect charts

                            Defects

                            Defect deltas

                        Quality assurance graphs
                        Quality assurance reports
                    Test results
                        Automated
                        Manual

            Process Activity Documentation

                    Source documentation
                        API

                            Javadoc

                            Source notes

                        Module references
                    Design documentation
                        Design diagrams
                        Design notes
                    Planning resources
                        Roadmap
                        Issue/defect reports
                        Enhancement charts
                        To do/task lists
                        Missing features
                        Requests for enhancement (RFE)
                        Persistent trouble reports
                        Plugins/modules that need removing
                        Plugins/modules that need hosting

            Software Resources

                    Binary object libraries
                    Source libraries
                    Binary releases
                    Source releases
                    Source Repositories
                        Daily source snapshots

        Usage

            Compilation

                    Tutorials/how-to guides
                    “Readme” files

            Installation

                    Tutorials/how-to guides
                    “Readme” files
                    Installation notes

            Configuration

                    Tutorials/how-to guides
                    “Readme” setup files
                    User manuals

            Use

                    Tutorials/How-tos
                        Getting started
                    Security tips
                    Security reports/vulnerability lists
                    Platform specific notes
                    Basic functionality
                    User manuals
                        Feature/Functionality lists

                            Basic

                            Advanced

        Management

            Managerial responsibilities

        3rd party/External relations

            Development

                    How-to integrate software with/into other projects

        Financial contributor

                How-to guides for sponsoring the projects

        Legal contributor