Writing a Pattern

A three-step guide to contributing security architecture patterns to OSA.

Here's our three-step process for creating security architecture patterns:

Step 1: Prepare and Research

Choose your pattern topic You should: - Identify the OSA area and use cases - Check existing work in our Google Groups forum - Define scope appropriately

Reserve a pattern number Post in our forums to claim the next available pattern identifier.

Get the latest templates Download SVG templates, icon packs, and pattern documentation from the library. Files should follow naming convention: "YY_MM_vv_Pattern_XXX_NAME"

Research your pattern topic Gather references from authoritative sources like NIST, Microsoft, Cisco, SANS, OWASP and others. Please avoid plagiarism and credit your sources appropriately.

Research prompts include: - Usage scenarios - Threat mitigation - Implementation efficiency - Industry best practices - Community feedback

Step 2: Design and Annotate Diagram

  • Construct visual patterns using Inkscape
  • Use 780x780 pixel documents
  • Follow left-to-right or top-to-bottom layout
  • Add control references using the HTML controls template

Step 3: Review and Publish

  • Upload to our forum for 2-4 weeks of community review
  • Incorporate feedback
  • Request core team publication to the library