Is it recommended to use DocBlock even if I’m not using phpDocumentor?
I’m developing a simple website for a client.
How To Document an Object Oriented Design in Text
For my next project, I’m looking to document my Object Oriented design in simple text before jumping the gun to code it up. I want to do this for two reasons.
HTML in docblock comments?
In the PEAR standards there is no reference to HTML, if its allowed or not.
Open source software with good code documentation to improve design skill [closed]
Want to improve this post? Provide detailed answers to this question, including citations and an explanation of why your answer is correct. Answers without enough detail may be edited or deleted. 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, […]
How to document unlimited argument parameters?
In PHP you can have a function take an infinite number of arguments like
Documentation degrading – how to deal with it?
Important: we have no issues whatsoever with source code documentation. This belongs to regular code audit and is kept up to date. Our problem is with developers documentation (or, “external” if you like), little blog-like tips from programmers to programmers which tend to be once written, often left behind.
Is functional spec a “design document”?
So I have been a bit lost in the terms, so first of all I present you what I have learned so far:
System requirements specification – what users want, what the system should do
Functional requirement – how the things, which users want, will actually work in the application
What standard superseded 830-1998?
I have been looking into how to document software projects more formally, and I have learned about IEEE 830-1998: Recommended Practice for Software Requirements Specifications. However, as you can see from that link, it has been superseded.
Are there any good, open-source change request systems? [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 to document and peer review design in scrum? [closed]
Closed 8 years ago.