GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - synopse/SynProject: SynProject Documentation Tool

BranchesTags
Open more actions menu

Latest commit

 

History

38 Commits
38 Commits

Folders and files

NameName
Last commit message
Last commit date
PasDocLight
PasDocLight
 
 
.gitattributes
.gitattributes
 
 
.gitignore
.gitignore
 
 
Default.ini
Default.ini
 
 
ProjectCommons.pas
ProjectCommons.pas
 
 
ProjectDiagrams.pas
ProjectDiagrams.pas
 
 
ProjectDiff.pas
ProjectDiff.pas
 
 
ProjectDiffUnit.pas
ProjectDiffUnit.pas
 
 
ProjectEdit.res
ProjectEdit.res
 
 
ProjectEditMain.dfm
ProjectEditMain.dfm
 
 
ProjectEditMain.pas
ProjectEditMain.pas
 
 
ProjectEditor.dfm
ProjectEditor.dfm
 
 
ProjectEditor.pas
ProjectEditor.pas
 
 
ProjectEditorCommit.dfm
ProjectEditorCommit.dfm
 
 
ProjectEditorCommit.pas
ProjectEditorCommit.pas
 
 
ProjectEditorProgram.dfm
ProjectEditorProgram.dfm
 
 
ProjectEditorProgram.pas
ProjectEditorProgram.pas
 
 
ProjectEditorRelease.dfm
ProjectEditorRelease.dfm
 
 
ProjectEditorRelease.pas
ProjectEditorRelease.pas
 
 
ProjectFormDocWizard.dfm
ProjectFormDocWizard.dfm
 
 
ProjectFormDocWizard.pas
ProjectFormDocWizard.pas
 
 
ProjectFormSelection.dfm
ProjectFormSelection.dfm
 
 
ProjectFormSelection.pas
ProjectFormSelection.pas
 
 
ProjectFormViewOne.dfm
ProjectFormViewOne.dfm
 
 
ProjectFormViewOne.pas
ProjectFormViewOne.pas
 
 
ProjectFormViewTwo.dfm
ProjectFormViewTwo.dfm
 
 
ProjectFormViewTwo.pas
ProjectFormViewTwo.pas
 
 
ProjectFrameRisk.dfm
ProjectFrameRisk.dfm
 
 
ProjectFrameRisk.pas
ProjectFrameRisk.pas
 
 
ProjectFrameViewer.dfm
ProjectFrameViewer.dfm
 
 
ProjectFrameViewer.pas
ProjectFrameViewer.pas
 
 
ProjectGraphEdit.dfm
ProjectGraphEdit.dfm
 
 
ProjectGraphEdit.pas
ProjectGraphEdit.pas
 
 
ProjectMemoExSyntax.pas
ProjectMemoExSyntax.pas
 
 
ProjectParser.pas
ProjectParser.pas
 
 
ProjectRTF.pas
ProjectRTF.pas
 
 
ProjectRes.rc
ProjectRes.rc
 
 
ProjectRes.zip
ProjectRes.zip
 
 
ProjectSections.pas
ProjectSections.pas
 
 
ProjectSpellCheck.dfm
ProjectSpellCheck.dfm
 
 
ProjectSpellCheck.pas
ProjectSpellCheck.pas
 
 
ProjectTrackerLogin.dfm
ProjectTrackerLogin.dfm
 
 
ProjectTrackerLogin.pas
ProjectTrackerLogin.pas
 
 
ProjectTrkTool.pas
ProjectTrkTool.pas
 
 
ProjectTypes.pas
ProjectTypes.pas
 
 
ProjectVersionBackup.dfm
ProjectVersionBackup.dfm
 
 
ProjectVersionBackup.pas
ProjectVersionBackup.pas
 
 
ProjectVersionCommit.dfm
ProjectVersionCommit.dfm
 
 
ProjectVersionCommit.pas
ProjectVersionCommit.pas
 
 
ProjectVersionCompare.dfm
ProjectVersionCompare.dfm
 
 
ProjectVersionCompare.pas
ProjectVersionCompare.pas
 
 
ProjectVersionMain.dfm
ProjectVersionMain.dfm
 
 
ProjectVersionMain.pas
ProjectVersionMain.pas
 
 
ProjectVersionPages.dfm
ProjectVersionPages.dfm
 
 
ProjectVersionPages.pas
ProjectVersionPages.pas
 
 
ProjectVersionSCR.dfm
ProjectVersionSCR.dfm
 
 
ProjectVersionSCR.pas
ProjectVersionSCR.pas
 
 
ProjectVersioning.pas
ProjectVersioning.pas
 
 
README.md
README.md
 
 
SynProject.dpr
SynProject.dpr
 
 
SynProject.ico
SynProject.ico
 
 
SynProject.res
SynProject.res
 
 
resource.bat
resource.bat
 
 
synproject.css
synproject.css
 
 
wizard2.png
wizard2.png
 
 

Repository files navigation

SynProject

Synopse SynProject is an open source application for code source versioning and automated documentation of Delphi projects.

Licensed under a GPL license.

Take a look at the SynProject official web site

Features

Its main features are:

  1. Local source code versioning;
  2. Automated documentation.

Source code versioning

  • handle multiple projects or libraries with the same program;
  • allow source code versioning with detailed commits;
  • can access to a PVCS tracker (more trackers are coming) and link the commits to the tickets;
  • allow automated source code backup (without any commit to document: it's like a daily snapshot of your files);
  • backups can be local (on your hard drive) or remote (on a distant drive);
  • you can make a visual "diff" and compare source code versions side by side in the graphical user interface;
  • you can see pictures (png jpeg bitmap icon) within the main user interface;
  • diff storage between version is very optimized, and use little disk space;
  • storage is based on .zip files and plain text files, so it's easy to work with.

Automated Documentation

  • follow a typical Design Inputs -> Risk Assessment -> Software Architecture -> Detailed Design -> Tests protocols -> Traceability matrix -> Release Notes workflow;
  • initial (marketing-level) Design Input can be refined into more precise Software Requirement Specifications;
  • Design Inputs can evolve during the project life: all documentation stay synchronized and you will have to maintain the DI and their description only at one place;
  • therefore, the process is meant to be compliant with the most precise documentation protocols (like IEC 62304); only one text file, formated like a wiki, contains the whole documentation;
  • it's very easy to add pictures, or formated source code (pascal, C, C++, C#, plain text) into the documentation;
  • word files (and then pdf) are created from this content, with full table of contents, picture or source code reference tables, unified page layout, customizable templates;
  • it's easy to add tables to your document, or link to other part or external resources * you can even put pure RTF content into your documentation;
  • pictures are centralized and captioned, people involved in the documentation are maintained once for the whole documentation;
  • document version numbering and cross-referencing is handled easily;
  • for pascal projects, the source code is parsed and all interface architecture is generated from the source; it's easy to browse classes, variables and functions from the documentation, and add reference to them to your document; the source code description can also be located in an external .sae file, therefore your original source code tree won't necessary be changed by the adding of comments;
  • all references are cross-linked: Software Architecture Document is created from the source code, and also is able to highlight the classes or methods - involved in implementing every Design Input, from the Software Design Document;
  • integrated GraphViz component, in order to create easily diagrams from plain text embedded into your documentation; * integrated fully featured text editor, with word wrapping, wiki-syntax buttons and keyboard shortcuts, and spell checking;
  • a step by step Wizard is available to create a new project, from supplied template files; another Wizard is already available, to browse your documentation workflow, and check its consistency or set up its parameters;
  • the documentation is integrated to the Versioning system above.

Of course, it's a full Open Source - GPL licensed - project. Source code (for Delphi 6/7) is available and maintained, since it is used by our internal projects (including our little mORMot).

About

SynProject Documentation Tool

Resources

Readme
Activity

Stars

31 stars

Watchers

8 watching

Forks

13 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.