Group Manual#

Summary of the group’s conventions, structure, and templates.

Group Style#

See https://style.dwermke.com for the group style.

tl;dr: Applicability of rules generally goes group guidelines > IEEE Editorial Style Manual > APA Style. When in doubt, ask your more experienced co-authors

Naming Conventions#

Projects and Files Naming#

We use consistent, time-sortable naming to keep projects, channels, and files easy to find and manage.

• Use lowercase and hyphens (-) to separate words. Avoid spaces, underscores, and special characters.
• Choose a short, specific slug for each project that reflects its actual scope and purpose
  • Examples: vuln-disclosure, slides-bar, weekly-reports, ctf
  • Avoid overly broad or ambiguous slugs like open-source-interviews (many of our projects involve open source interviews, so this is not specific enough)
• Use the same slug consistently across repositories, documents, folders, and communication channels
• Prefix resources with an ISO 8601 date: YYYY, YYYY-MM, or YYYY-MM-DD depending on how granular the file’s context is.
  Good

  • 2025-ctf.md (annual scope)
  • 2025-03-vuln-disclosure.md (monthly scope)
  • 2025-03-25-meeting-notes.md (specific date)
• Do not use version schemes Instead, use version control systems to manage changes and updates, change the ISO date string to reflect a newer version, or as last resort use proper version number like -v2 if not avoidable.
  Bad “-final”, “-edited”, “-new-final”, etc.

Meeting Naming#

Dom: Bit of a pet peeve of mine, but I sometimes struggle with the meeting names scheduled into my calendar by students, especially in the condensed mobile view.

Use a combination of project name and meeting type for calendar name:

Try to avoid really ambiguous names like “Group meeting” or “Weekly sync”, I have multiple of those per week.

Try also to include the type of meeting, e.g. “Sync”, “Weekly”, “Scrum”, “Kickoff” etc. This avoids confusion around titles like “SSC Interview” which looks like an actual interview sit-in but is probably meant as a weekly project meeting.