Skip to content

Documenting class groupings #245

Open
@samWson

Description

@samWson

Following on from #215 I played around with yEd to make class graphs similar to how I had drawn them before. Same concept as before. I'm not following any particular standard, just grouping classes by function/responsibility and any critical interactions. Here is an example:

external-api

I figure one group of classes per diagram. The repo can have a png/pdf of the diagram for viewing and the graphml file which can be edited for easy updating.

Let me know if you want to pursue this documentation task. I know it certainly helped me get my head around how our repo works so it can definitely help others. I'll be happy to do the work as I've already done the investigation and know I can do it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationConcerning documentation of the repo

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions