Win a copy of Testing JavaScript Applications this week in the HTML Pages with CSS and JavaScript forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Bear Bibeault
  • Ron McLeod
  • Jeanne Boyarsky
  • Paul Clapham
Sheriffs:
  • Tim Cooke
  • Liutauras Vilda
  • Junilu Lacar
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Tim Holloway
  • fred rosenberger
  • salvin francis
Bartenders:
  • Piet Souris
  • Frits Walraven
  • Carey Brown

Need help in Software Documentation of ERP project

 
Ranch Hand
Posts: 674
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi there


I am making my first Project(As part of Real life).We are a group of 5 people.We are making a Web Application of ERP.As we have gather a lot of information from Net.
But We need some help that how we should document our project that all thing each and every from databases to css ,MVC everything will be listed their.

Although we have figured out what this project will do.But how to document this like a Professional Software development.


We want to know How professional software are documented before they start development.




All are who have experience in developing software and documentaion are invited to share their experience.

We also want to know How a team of 5 people can implement Agile Methodology so that output of this project is like a professional software ERP


Thanks
 
Marshal
Posts: 69884
278
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The documentation should be as documentation comments in the first instance. You can add an instruction book later. Read about documentation comments in Joshua Bloch's Effective Java™ 2nd edition and in the Oracle documentation; there are two other links at the top of that link which you should read too.
 
author
Posts: 23879
142
jQuery Eclipse IDE Firefox Browser VI Editor C++ Chrome Java Linux Windows
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

ERP is a term that refers to a ton of different business processes, spanning many different stake holders across the business. And ERP products are generally a suite of products.

Perhaps... it would be a good idea to have more focus on what you are building? Especially as the first product? ...

Henry
 
Kishor Joshi
Ranch Hand
Posts: 674
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
we are looking for ideas that how to make this documentaion for Internal Users Like How data will flow and it works?database interactions,software coding and all

So we want some guide on that.


Please give to the point answar like
how database interaction should be make on project.What design and what element needed
How coding will work?


any clarfications?

 
Rancher
Posts: 43016
76
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Agree with Henry - this is likely to be a cross-functional and cross-departmental project. There needs to be project management, and that can't be done by the developers (both because they're supposed to be developing, and because it sounds like the necessary skill set is not present in your team).
 
Kishor Joshi
Ranch Hand
Posts: 674
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I agree with you Ulf

We are not developing all the module like a big ERP of SAP.

But we are just starting.So We just want to know How we should document first all system architecture.
We are not asking How we will do this(We knew it).But How to make a professional looking document that help in product development.And after that in maintenance.

Like Diagram,data flows,Coding Interation users.

We want to know step by step from where we should start.

We have figured out Raw requirements of project


Thanks
 
Think of how stupid the average person is. And how half of them are stupider than that. But who reads this tiny ad?
Thread Boost feature
https://coderanch.com/t/674455/Thread-Boost-feature
    Bookmark Topic Watch Topic
  • New Topic