|
| 1 | +/****************************************************************************** |
| 2 | + * Software Diversity Card Scaffold * |
| 3 | + ****************************************************************************** |
| 4 | + * This file provides the initial scaffold for creating a Software Diversity * |
| 5 | + * Card. Follow the steps below to set up your card properly. * |
| 6 | + ****************************************************************************** |
| 7 | + * 1️⃣ Governance: * |
| 8 | + * - Specify the governance-related bodies of the software project. * |
| 9 | + ****************************************************************************** |
| 10 | + * 2️⃣ Usage Context: * |
| 11 | + * - Define the target communities of your software * |
| 12 | + * - Define the deployment context and particular use cases of the software* |
| 13 | + * - Define the adaptations of the software for specific social groups * |
| 14 | + ****************************************************************************** |
| 15 | + * 3️⃣ Participants: * |
| 16 | + * - Declare the different teams and individuals involved in your project. * |
| 17 | + * - Declare your dev team, testers, reporters, or translators * |
| 18 | + ****************************************************************************** |
| 19 | + * ✅ Final Steps: * |
| 20 | + * - Ensure your file has no validation errors. * |
| 21 | + * - Generate the JSON and Markdown representations for easy sharing. * |
| 22 | + * - Embed the Markdown output in repositories or publish it online. * |
| 23 | + ****************************************************************************** |
| 24 | + * 🔗 Need Help? * |
| 25 | + * - If you have any questions, open an issue in our public repository: * |
| 26 | + * 👉 https://github.com/SOM-Research/SoftwareDiversityCard * |
| 27 | + ******************************************************************************/ |
| 28 | + /****************************************************************************** |
| 29 | + * Master Info * |
| 30 | + ******************************************************************************/ |
| 31 | +softwareName:"The title or name of the software project" |
| 32 | +softwareDescription "The description of the software" |
| 33 | + |
| 34 | +/****************************************************************************** |
| 35 | + * Governance * |
| 36 | + ****************************************************************************** |
| 37 | + * Define the governance structure for your software project. Specify the * |
| 38 | + * organizations or individuals responsible for oversight and decision-making.* |
| 39 | + * Include key demographic and professional attributes to profile these groups.* |
| 40 | + ******************************************************************************/ |
| 41 | +organization SoftwareAssociation |
| 42 | + ageRange: (23,46) |
| 43 | + locations: ['USA'] |
| 44 | + workplaceType: hybrid |
| 45 | + ethnicities: ['Asian', 'White'] |
| 46 | + genders: ['male', 'female'] |
| 47 | + disabilities: ['blind'] |
| 48 | + sexualOrientations: ['Straight'] |
| 49 | + religiousBeliefs: ['Christianism', 'Muslim'] |
| 50 | + countries: [UnitedStatesofAmerica,Oman] |
| 51 | + educationalLevels: [bachelorEquivalent,doctorateEquivalent] |
| 52 | + spokenLanguages: [(English,c1),(Arabic,c1)] |
| 53 | + socioEconomicStati: [upperClass, upperMiddleClass] |
| 54 | + skillLevels: [advanced, expert] |
| 55 | + averageTenure: 36 |
| 56 | + |
| 57 | +body SoftwareBoard |
| 58 | + description: "The board of the software" |
| 59 | + bodyType: directors |
| 60 | + organizations: [SoftwareAssociation] |
| 61 | + |
| 62 | +body publicFunder |
| 63 | + description: "public funder" |
| 64 | + bodyType: funders |
| 65 | + |
| 66 | +governance SoftwareGovernance |
| 67 | + projectType: "the type of the project" |
| 68 | + governanceProcesses: ["The list of governament processes", ""] |
| 69 | + bodies: [SoftwareBoard,publicFunder] |
| 70 | +/****************************************************************************** |
| 71 | + * Usage context * |
| 72 | + ****************************************************************************** |
| 73 | + * Define the primary target communities for your software. Provide details * |
| 74 | + * such as demographic characteristics, geographic locations, and other * |
| 75 | + * user-specific traits. * |
| 76 | + ******************************************************************************/ |
| 77 | +targetCommunity nonDigitalSkilled |
| 78 | + description: 'Elder people with low tech skills' |
| 79 | + ageRange: (60,100) |
| 80 | + locations: ['Spain'] |
| 81 | + workplaceType: hybrid |
| 82 | + ethnicities: ['White'] |
| 83 | + genders: ['male', 'female'] |
| 84 | + countries: [Spain] |
| 85 | + educationalLevels: [primary] |
| 86 | + spokenLanguages: [(Spanish-Castilian,c2)] |
| 87 | + socioEconomicStati: [lowerClass, lowerMiddleClass] |
| 88 | + skillLevels: [beginner] |
| 89 | + averageTenure: 70 |
| 90 | + |
| 91 | +/****************************************************************************** |
| 92 | + * Social Context & Use Cases * |
| 93 | + ****************************************************************************** |
| 94 | + * Describe the broader social environment and real-world scenarios where the * |
| 95 | + * project is deployed. Include cultural, regional, or community-specific * |
| 96 | + * details that could impact software use and adaptation. * |
| 97 | + ******************************************************************************/ |
| 98 | +socialContext SocialContext |
| 99 | + description: 'This is a description of the social context where the project is deployed' |
| 100 | + country: Spain |
| 101 | + spokenLanguages: [Catalan-Valencian] |
| 102 | + |
| 103 | +useCase nonSkilledAccesibityCitizen |
| 104 | + description: 'Acces for non-skilled digital citizen' |
| 105 | + targetCommunities: [nonDigitalSkilled] |
| 106 | + |
| 107 | +/****************************************************************************** |
| 108 | + * Software Adaptations * |
| 109 | + ****************************************************************************** |
| 110 | + * Specify adaptations implemented in the software to meet the needs of various * |
| 111 | + * target communities. Link these adaptations to their corresponding use cases * |
| 112 | + * and responsible teams for clarity and traceability. * |
| 113 | + ******************************************************************************/ |
| 114 | +adaptation DigitalDivide |
| 115 | + description: 'Adaptations for digital devices' |
| 116 | + useCases: [nonSkilledAccesibityCitizen] |
| 117 | + targetCommunities: [nonDigitalSkilled] |
| 118 | + relatedTeams: [DevelopmentTeam] |
| 119 | + |
| 120 | +/****************************************************************************** |
| 121 | + * Participants * |
| 122 | + ****************************************************************************** |
| 123 | + * Individuals: Optionally, list individual participants involved in project. * |
| 124 | + * Include relevant personal information to profile each contributor. * |
| 125 | + ******************************************************************************/ |
| 126 | +participant Developer1 |
| 127 | + age: 46 |
| 128 | + location: 'Barcelona' |
| 129 | + workplaceType: presential |
| 130 | + ethnicity: 'Asian' |
| 131 | + gender: 'female' |
| 132 | + disabilities: [''] |
| 133 | + sexualOrientation: '' |
| 134 | + religion: '' |
| 135 | + country: Spain |
| 136 | + educationalLevel: masterEquivalent |
| 137 | + spokenLanguages: [(English,c1)] |
| 138 | + socioEconomicStatus: upperMiddleClass |
| 139 | + skillLevel: proficient |
| 140 | + tenure: 4 |
| 141 | + participantId: 'semo' |
| 142 | + |
| 143 | +participant Developer2 |
| 144 | + age: 45 |
| 145 | + location: 'Barcelona' |
| 146 | + workplaceType: presential |
| 147 | + ethnicity: 'Black' |
| 148 | + gender: 'male' |
| 149 | + disabilities: [''] |
| 150 | + sexualOrientation: '' |
| 151 | + religion: '' |
| 152 | + country: Spain |
| 153 | + educationalLevel: masterEquivalent |
| 154 | + spokenLanguages: [(English,b2)] |
| 155 | + socioEconomicStatus: upperMiddleClass |
| 156 | + skillLevel: advanced |
| 157 | + tenure: 5 |
| 158 | + participantId: 'enca' |
| 159 | + |
| 160 | +participant Tester1 |
| 161 | + age: 45 |
| 162 | + location: 'Barcelona' |
| 163 | + workplaceType: presential |
| 164 | + ethnicity: 'Black' |
| 165 | + gender: 'male' |
| 166 | + disabilities: [''] |
| 167 | + sexualOrientation: '' |
| 168 | + religion: '' |
| 169 | + country: Spain |
| 170 | + educationalLevel: masterEquivalent |
| 171 | + spokenLanguages: [(English,b2)] |
| 172 | + socioEconomicStatus: upperMiddleClass |
| 173 | + skillLevel: advanced |
| 174 | + tenure: 5 |
| 175 | + participantId: 'enca' |
| 176 | + |
| 177 | +participant Tester2 |
| 178 | + age: 45 |
| 179 | + location: 'Barcelona' |
| 180 | + workplaceType: presential |
| 181 | + ethnicity: 'Black' |
| 182 | + gender: 'male' |
| 183 | + disabilities: [''] |
| 184 | + sexualOrientation: '' |
| 185 | + religion: '' |
| 186 | + country: Spain |
| 187 | + educationalLevel: masterEquivalent |
| 188 | + spokenLanguages: [(English,b2)] |
| 189 | + socioEconomicStatus: upperMiddleClass |
| 190 | + skillLevel: advanced |
| 191 | + tenure: 5 |
| 192 | + participantId: 'enca' |
| 193 | + |
| 194 | + /****************************************************************************** |
| 195 | + * Teams: Define the various teams participating in the software project. * |
| 196 | + ****************************************************************************** |
| 197 | + * Testers: The team of testers, could be end-users or internal testers * |
| 198 | +*******************************************************************************/ |
| 199 | +testerTeam usabilityTesters |
| 200 | + description: 'equipo de testeo de usabilidad' |
| 201 | + startDate: 11-08-2024 |
| 202 | + endDate: 08-29-2025 |
| 203 | + teamSize: 4 |
| 204 | + iterations: 3 |
| 205 | + teamParticipants: [( |
| 206 | + Tester1,developer,11-08-2024,08-29-2025), |
| 207 | + (Tester2,developer,11-08-2024,08-29-2025) |
| 208 | + ] |
| 209 | + ageRange: (34,46) |
| 210 | + locations: ['Barcelona'] |
| 211 | + workplaceType: hybrid |
| 212 | + ethnicities: ['Asian'] |
| 213 | + genders: ['male'] |
| 214 | + disabilities: [''] |
| 215 | + sexualOrientations: [''] |
| 216 | + religiousBeliefs: [''] |
| 217 | + countries: [Spain] |
| 218 | + educationalLevels: [masterEquivalent] |
| 219 | + spokenLanguages: [(English,c1)] |
| 220 | + socioEconomicStati: [upperClass] |
| 221 | + skillLevels: [competent] |
| 222 | + averageTenure: 4.3 |
| 223 | + testersBackground: '' |
| 224 | + testingGuidelines: '' |
| 225 | + appMaturity: '' |
| 226 | + |
| 227 | + /****************************************************************************** |
| 228 | + * User reporters: Crowd of users reporting feedback from the software usage * |
| 229 | +*******************************************************************************/ |
| 230 | +publicReporterTeam userReporting |
| 231 | + description: 'public reporting team' |
| 232 | + startDate: 11-08-2024 |
| 233 | + endDate: 08-29-2025 |
| 234 | + teamSize: 200 |
| 235 | + iterations: 2 |
| 236 | + ageRange: (20,30) |
| 237 | + locations: ['Barcelona'] |
| 238 | + workplaceType: hybrid |
| 239 | + ethnicities: ['white'] |
| 240 | + genders: ['male'] |
| 241 | + disabilities: [''] |
| 242 | + sexualOrientations: [''] |
| 243 | + religiousBeliefs: [''] |
| 244 | + countries: [Spain] |
| 245 | + educationalLevels: [masterEquivalent] |
| 246 | + spokenLanguages: [(English,c1)] |
| 247 | + socioEconomicStati: [middleClass] |
| 248 | + skillLevels: [beginner] |
| 249 | + averageTenure: 4.2 |
| 250 | + reportingMethod: "public interviews" |
| 251 | + reportingPlatform: "public council" |
| 252 | + |
| 253 | + /****************************************************************************** |
| 254 | + * Non coding contributors: E.G. Translators of the software project * |
| 255 | +*******************************************************************************/ |
| 256 | +nonCodingContributorTeam Translators |
| 257 | + description: 'remote translators team' |
| 258 | + startDate: 11-08-2024 |
| 259 | + endDate: 08-29-2025 |
| 260 | + teamSize: 50 |
| 261 | + ageRange: (20,30) |
| 262 | + locations: ['Barcelona', 'Madrid', 'Granada'] |
| 263 | + workplaceType: remote |
| 264 | + ethnicities: ['white'] |
| 265 | + genders: ['male'] |
| 266 | + disabilities: [''] |
| 267 | + sexualOrientations: [''] |
| 268 | + religiousBeliefs: [''] |
| 269 | + countries: [Spain] |
| 270 | + educationalLevels: [masterEquivalent] |
| 271 | + spokenLanguages: [(English,c1)] |
| 272 | + socioEconomicStati: [middleClass] |
| 273 | + skillLevels: [beginner] |
| 274 | + averageTenure: 4.2 |
| 275 | + |
| 276 | + |
| 277 | + /****************************************************************************** |
| 278 | + * Non coding contributors: E.G. The issue reporters * |
| 279 | +*******************************************************************************/ |
| 280 | +nonCodingContributorTeam issueReporters |
| 281 | + description: 'external issue reporting team' |
| 282 | + startDate: 11-08-2024 |
| 283 | + endDate: 08-29-2025 |
| 284 | + teamSize: 50 |
| 285 | + ageRange: (20,30) |
| 286 | + locations: [''] |
| 287 | + workplaceType: remote |
| 288 | + ethnicities: ['white'] |
| 289 | + genders: ['male'] |
| 290 | + disabilities: [''] |
| 291 | + sexualOrientations: [''] |
| 292 | + religiousBeliefs: [''] |
| 293 | + countries: [Spain] |
| 294 | + educationalLevels: [masterEquivalent] |
| 295 | + spokenLanguages: [(English,c1)] |
| 296 | + socioEconomicStati: [middleClass] |
| 297 | + skillLevels: [beginner] |
| 298 | + averageTenure: 4.2 |
| 299 | + |
| 300 | + |
| 301 | + /****************************************************************************** |
| 302 | + * Development Team * |
| 303 | +*******************************************************************************/ |
| 304 | +developmentTeam DevelopmentTeam |
| 305 | + description: 'development team' |
| 306 | + startDate: 11-08-2024 |
| 307 | + endDate: 08-29-2025 |
| 308 | + teamSize: 4 |
| 309 | + iterations: 3 |
| 310 | + teamParticipants: [( |
| 311 | + Developer1,developer,11-08-2024,08-29-2025), |
| 312 | + (Developer2,developer,11-08-2024,08-29-2025)] |
| 313 | + ageRange: (34,46) |
| 314 | + locations: ['Barcelona'] |
| 315 | + workplaceType: hybrid |
| 316 | + ethnicities: ['Asian'] |
| 317 | + genders: ['male'] |
| 318 | + disabilities: [''] |
| 319 | + sexualOrientations: [''] |
| 320 | + religiousBeliefs: [''] |
| 321 | + countries: [Spain] |
| 322 | + educationalLevels: [masterEquivalent] |
| 323 | + spokenLanguages: [(English,c1)] |
| 324 | + socioEconomicStati: [upperClass] |
| 325 | + skillLevels: [competent] |
| 326 | + averageTenure: 4.3 |
| 327 | + |
0 commit comments