resume-schema.md

Resume Schema

This schema is an attempt to afford a resume the ability to describe the variety of information provided and required to communicate the breadth and depth of experience found in a software career.

{
    "version": string, // Date of last update
    "current": Workplace,
    "past": Workplace[],
    "skills": SkillAspect[],
    "community": CommunityAspect[]
}

Workplaces

Workplaces are groupings by employer, or as self-employed, that detail a particular span of time.

{
    "workplace": string, // Employer or Organization
    "workplaceUrl": string | undefined, // URL of employer or organization
    "start": Date, // String representation of this workplace's start date
    "end": Date | undefined, // String representation of this workplace's end date
    "description": string | undefined, // Multiline string describing this workplace in detail
    "roles": Role[]
}

Roles

Roles detail defined spans of time (may be ongoing) to convey experience and responsibilities in both a narrative description and set of skills utilized. Multiple roles may be found within a single workplace.

{
    "title": string, // Job title or role
    "start": Date | undefined, // String representation of this position's start date
    "end": Date | undefined, // String representation of this position's end date
    "description": string | undefined, // Multiline string describing this role in detail
    "outcomes": string[] | undefined // Array of line items to call out achievements and learnings in a given role
}

Aspects

Aspects are varying pieces of information that may be relevant to inform specific details not covered in Roles.

CommunityAspect

Details of a community-related activity, nominally a service position or specific outstanding experience.

{
    "title": string, // Aspect title, short name or description
    "date": string, // Date (range)
    "description": string, // Multiline string describing this experience in detail
    "location": string | undefined,// Location
    "video": string | undefined, // URL of video
    "slides": string | undefined // URL of slide deck
}

SkillAspect

Details of skills, may be nested, to provide context related to other parts of the resume.

{
    "skill": string | undefined, // Short description of a skill
    "skills": SkillAspect[] | string[] | undefined
}