SpecsBuilder

• 00_About
  • SpecsBuilder
• 01_Roadmap
  • no_deadline
• 02_Development
  • 01_Process
    • participate
  • 02_Getting_started
    • requirements
  • 03_Frameworks_and_Tools
    • libraries
  • 04_Conventions
    • no-convention
  • 05_Technical_Documentation
    • architecture
• 03_Work_In_Progress
  • toDo
• 04_Release_Notes
  • versions
• 05_Maintenance_and_Support
  • 01_Infrastructure
    • check_requirements
  • 02_Deploy_Guide
    • deployment
  • 03_Technical_Support
    • contact
  • 04_Accounts
    • no-account
  • 05_Who_s_Who
    • anon
• 06_User_Documentation
  • using_SpecsBuilder
• 07_Notes
  • author

00_About

SpecsBuilder

DevSpecs is a little PHP app created in order to make dev specs writing more "dev-friendly".
Did you finish and test a module ? Describe it in a simple HTML file with tags around your text (no DOCTYPE !), while you brains are still hot.
At every moment, your documentation is ready to be consulted / printed / copied as HTML or plain text / or exported as a DOC file. Without leaving your dev environment, you just have to integrate this repository to your app's folder.
You can see the result thanks to the index.php file placed at the root of this repository.
You are going to put your documentation in content/. By default, a basic structure is implemented. You can change the name of the folders and files existing in content/, and create as many as you want. The files have to be inserted with an .html extension and HTML tags are supported, of course - however, don't care about DOCTYPE, HTML's head content and body tags, which are handled by index.php when it merges the specs.

01_Roadmap

no_deadline

First proposed on GitHub on March 7, 2021.

02_Development

01_Process

participate

Wanna work on this project ? Contact me :)

02_Getting_started

requirements

This app is written in PHP, so you need a server (local or remote) with at least Apache and PHP installed on it.
This app was developed with PHP 7.4.3 and Apache 2.4.41 (Ubuntu version).
Some CDN links are used to provide Bootstrap styles : you need to be connected to Internet to enjoy the expected user experience.

03_Frameworks_and_Tools

libraries

Bootstrap library is used for style. In order to use it properly, jQuery is also used. CDN links are placed in the head tag of index.php.

04_Conventions

no-convention

Nothing special to say here.

05_Technical_Documentation

architecture
• assets/
  
  • css/
    
    • app.css
    • bootstrap.min.css
  • fonts/
    
    • Open_Sans/
      
      • LICENSE.txt
      • OpenSans-Regular.ttf
    • Raleway/
      
      • static/
        
        • Raleway-Black.ttf
        • Raleway-BlackItalic.ttf
        • Raleway-Bold.ttf
        • Raleway-Bold.ttf
        • ...
      • OFL.txt
      • Raleway-VariableFont_wght.ttf
      • README.txt
  • img/
  • js/
    
    • app.js
    • bootstrap.min.js
    • jquery-3.5.1.js
• content/
  
  • 00_About/
    
    • SpecsBuilder.html
  • 01_Roadmap/
    
    • no_deadline.html
  • 02_Development/
    
    • 01_Process/
      
      • participate.html
    • 02_Getting_started/
      
      • requirements.html
    • 03_Frameworks_and_Tools/
      
      • libraries.html
    • 04_Conventions/
      
      • no-convention.html
    • 05_Technical_Documentation/
      
      • architecture.html
  • 03_Work_In_Progress/
    
  • 04_Release_Notes/
    
  • 05_Maintenance_and_Support/
    
  • 06_User_Documentation/
    
  • 07_Notes/
    
    • author.html
    • source.html
• app.php
• index.php

03_Work_In_Progress

toDo

PDF Export

Implement JSPDF in app.js


PHP inserting ?

Didn't find a way to make include file.php in the display() function // app.php

04_Release_Notes

versions

Current version : 0.0.0 March 7, 2021

Previous releases :

05_Maintenance_and_Support

01_Infrastructure

check_requirements

Please refer to the app's requirements.

02_Deploy_Guide

deployment

You just have to clone this GitHub repository to your project's root, or to download it as a ZIP file, to unzip it and to put it to the root of your app.
Now you can access the default documentation with your navigator : http://myapp/SpecsBuilder

03_Technical_Support

contact

Do you need me to help you ? Find some contact links in the notes section.

04_Accounts

no-account

Is this file useful ? Hmm...

05_Who_s_Who

anon

Well... same comment

06_User_Documentation

using_SpecsBuilder
1. Clone the GitHub repository to your project's root, or download it as a ZIP file, then unzip it and put it at the root of your app.
   Now you can access the default documentation with your navigator : http://myapp/SpecsBuilder
2. You can modify the title of your specs by changing the SpecsBuilder/ folder name.
3. You can modify all folders under SpecsBuilder/content/ or create new ones.
4. You can modify HTML files contained under content/, or create new ones.
   Don't insert any DOCTYPE / head / body tags.
5. You can copy, print, export your specs !

07_Notes

author

Did you find this work useful ? Visit my website here ! You can also find me on GitHub