What should I aware of , when preparing a document of website for later maintenance use? [closed]
As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references, or expertise, but this question will likely solicit debate, arguments, polling, or extended discussion. If you feel that this question can be improved and possibly reopened, visit the help center for […]
In what stage of development should comments be written?
I’m a student working an internship at a larger company, writing small business apps in C#. I’ve noticed that I don’t comment my code as I write it. Rather, I comment my code when I’m in the debugging stage of development. As I’m tracking down bugs, I’ll run across a block that makes me think “hmm…that might confuse someone in the future. I’d better comment that”, and I’ll add the appropriate comments. All of my comments are done this way.
What’s a good length for Javadoc for a class that is say 800 lines long?
I’m doing a code-review on someone’s code for class.
SpecFlow/Cucumber – Documenting available steps [closed]
It’s difficult to tell what is being asked here. This question is ambiguous, vague, incomplete, overly broad, or rhetorical and cannot be reasonably answered in its current form. For help clarifying this question so that it can be reopened, visit the help center. Closed 11 years ago. Our company is looking at implementing BDD in […]
Software Manager who makes developers do Project Management
I’m a software developer working in an embedded systems company.
We have a Project Manager, who takes care of the overall project schedule (including electrical, quality, software and manufacturing) hence his software schedule is very brief.
Commenting regular expressions
Are there any common practises for commenting the regular expressions: inline comments referring different part of RegEx or general comment for all expression?
Is a functional spec a part of the System requirement spec?
I wonder, sources like wikipedia or templates I found shows that Functional spec is a part of System requirement documents. I always thought that SRD is just overall decsription of the system, with all functional and non functional requirements. Yet I thought that Functional spec is more detailed and it is a separate document, while SRD is high level customer-created description (how is this one called then?)
Could anyone help to make this clear for me?
Questions to ask a 3rd party API provider [closed]
As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references, or expertise, but this question will likely solicit debate, arguments, polling, or extended discussion. If you feel that this question can be improved and possibly reopened, visit the help center for […]
How does one read RFCs and similar documents? [closed]
Closed 9 years ago.
Formalizing a requirements spec written in narrative English
I have a fairly technical functionality requirements spec, expressed in English prose, produced by my project manager. It is structured as a collection of UI tabs, where the requirements for each tab are expressed as a lit of UI fields and a list of business rules for the tab.