Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 3 years ago.
Improve this question
I call this a flash meeting, but maybe there is another more appropriate name.
Once in a while (and sometimes more often) one of my developers comes to my desk and asks how he should code a particular piece of code.
The code itself is not directly answering a feature, meaning that it hasn't been designed during requirements, but it is part of the feature's internal behavior.
After discussing for 5 minutes, we settle on a solution. My question is how should I record that discussion so that in the future, when someone else looks at that piece of code, that person will understand why it was developed this way and not that way?
Should I ask the developer to write directly in the code the summary of the discussion, or should I open up a Word template and write down the discussion as if it was a 2 hour meeting? Any suggestions?
This is where having a development wiki really pays off. You can just create a wiki page for the flash meeting, and link it to relevant other pages. Write up what was discussed, then ask the other programmers to check it and update as they see fit. There is one place to record everything and you can link it to whatever else you need, for instance SVN urls to a code branch or link to other wiki pages for the other people involved, the codebase being worked on. Later on, if you need to look it up, you can also search for keywords which you put into the wiki page specifically to make it easy to find later.
I'd do it with the code, as long as its not an essay. a brief paragraph and you're done.
There's nothing that would bother me more than viewing a piece of code and then having to go down to some share to look for a word document that explains it.
As long as its a small feature related discussion. big design stuff should go into its own meta document, most likely.
History information can go into version control checkin comments
In the information can be captured briefly, then one option is for the developer to describe the discussion in the comment when s/he checks the file(s) into version control. If you don't trust developers to look in source control if they have questions, then add "See checkin comments for this file on mm/dd/yy" in a comment in the source before checking it in.
Related
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 3 years ago.
Improve this question
I came to a successful project with 4 years old, it is already in the production.
The problem is that, the project is not documented anymore, it depends on 2 senior developers only, they know the system, they test, they handle change of requests..
I need to know what is the best practice, or what are the main steps that I have to do in order to document all the modules starting from high level design through component analysis & design, code comments, till the configuration management.
The traditional project management processes don't give me a clear idea of how to take the control back of a an old project.
Thanks.
Senior developers will easilly get bothered if you make them write docummentation all day long so you may lose them at the end.
I would hire a technical writer / junior developer if I were you and give him or her this as a first task. I would also make him or her work closelly with the senior guys, without taking too much from their time (like aggregating questions and have a one hour session dailly or something like that).
It will probably hurt in the beginning but if properly executed should prove a good choice at the end.
Note: The level of cooperation between your senior guys and the new guy that will be doing the documentation may vary depending on some internal "political" things like if the developers feel threatened by the fact that you are trying to make them less critical to the project, how overwhealming the new guy / gal is to them and so on. So answer those questions before going for it.
Once again - it is my personal opinion on the given topic and its success will definatelly depend on various factors. So you should decide if it is a good way to go or not.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 7 years ago.
Improve this question
I have been wondering why so many coders have bad organization in their documents.
I think I know why.
As usual it has to do with standardization. If no standard it out there, everyone has to reinvent the wheel all the time.
So I upload a gem at RubyGems.org. But that was only 1/4 of it all.
I have to write a tutorial for it, making categories, text style, size, color etc
I have to generate API documentation from my code
I have to put it in Git-hub (never done this, but that should be correct?)
It's a painful process.
Wouldn't it be great if every gem followed the same documentation structure. You upload your gem, you write a documentation for it that everyone can edit, the API documentation has been generated too, maybe created automatically, if you provided your account information for example.
A good process.
I think that would boost up good collaboration and environment than every gem has its own structure (bad documentations) and putting API documentation here and there.
Don't you agree?
Would be nice if it were more of a style like that. It's worked well for wiki's having the content changeable by the community. I've found that gem documentation can be hit or miss sometimes. I think having the documentation editable would be good because people could rewrite parts that are unclear making it much more user friendly
Great suggestion!
This kind of documentation (tutorial, non-generated doc, ...) is better addressed by a wiki.
Most of the public source container out there now integrates one in their features.
GitHub recently improves its own wiki system.
It also proposes GitHub pages (for publishing content to the web by simply pushing content to one of your GitHub hosted repositories, with user pages or project pages, and with Jekyll for even more Makdown file formats)
Closed. This question is off-topic. It is not currently accepting answers.
Want to improve this question? Update the question so it's on-topic for Stack Overflow.
Closed 10 years ago.
Improve this question
Are there any services that allow you to place advertising in Windows software? I want to give away my software for free but still need to eat!
Check out OpenCandy, they have a really nice concept IMHO:
only a single, opt-in ad - in the installer (so your application remains ad-less). There is an interesting post about them # DonationCoder.
It is, of course, trivial to put a fixed collection of adverts into your code. The trouble comes if you want to sell eyeballs and have the ads change. Then the code has to go talk over the network to get new adds.
Many people would have a name for this: adware. If people find you making network connections behind their back, as it were, they are likely to break out some more negative terms.
However, if you are completely open and honest about it when you offer the code for download, then your conscience might be clear.
Practically, you need to have code that makes a network connection to some site of yours, pulls the ad content, and displays it in some sort of annoying popup.
Check with individual affiliate programs to see if they allow links in applications.
You can also try the Freemium model: Turn on some extra features if they pay for your program.
Or link to your website for support information, instructions, etc., and place ads there.
Or offer an e-mail newsletter with updates, news, etc. Advertising in these is easier.
You can also ask this over at http://www.startups.com
Closed. This question needs details or clarity. It is not currently accepting answers.
Want to improve this question? Add details and clarify the problem by editing this post.
Closed 6 years ago.
Improve this question
A client asked me if I knew anything about the HOME development method. I, together with wikipedia and acronymfinder, drew a complete blank.
Has anyone here heard about a development method called HOME?
The best answer to this is to follow this link and read the shrt description of the method by the authors themselves.
http://nyttf.dk/?pagetype=book&vareid=44021-1
I can recommend this method as I teach it in project management at a Business Academy for Multimedia Designers i Denmark
The closest thing I found that mentioned a HOME development model was this document on Google Books. Apparently, it stands for Holistic, Open Multimedia development Method. But without context, I can't be sure this is right. But my best guess is that if this isn't right, it's another acronym.
You probably have your answer by now.
(Developing Multimedia- A Holistic Approach , by Maire Oosterbaan and Louise Harder Fischer)
HOME - holistic open multimedia development method it is a method based on two principles:
holistic meaning that all activities are viewed from both a product-oriented and a process-oriented point of view.
It is open, meaning it can be adjusted to most developement scenarios and types and products.
I've never heard of it, either.
I'm sure there's a way for you to garner insight from your client as to what he means.
Perhaps you could ask something like, "In what context are you interested in knowing more about HOME?"
Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 9 years ago.
Improve this question
Does anyone know of any software or a good way for developers to build up a knowledge base of business rules that are built in to the software for help desk to use?
We already have a helpdesk software but we are not looking to replace this.
A wiki is definitely the way to go. Processes change, sometimes frequently, and in a fast-paced environment like a help desk a tool that allows quick, easy access and management of that type of content is extremely important to allow people to do their jobs effectively.
One of the greatest benefits I've found is the heiarchical sturcture of many wikis, allowing employees to find the correct content from a number of different customer angles.
Can you be more specific?
This may fall under "policies and procedures" management software. Here are some:
http://www.softscout.com/software/Human-Resources/Policy-and-Procedures.html
I'd like to find one that's more wiki-like or easier to integrate into a a website serving as a more general company knowlege base.
I would recommend a wiki wiht a "Wiki Gardener" role- someone who cleans up the duplicate entries and sorts.
Wiki technology with a Rich Text Editor option would useful if your Support Desk are not totally technical.
Having some structure is imperative, developing something in any Wiki that makes sense to the general editing populace, and has a low threshold to get from reading to editing. You will also possibly need a migration strategy for taking hundereds of little notes into something more readable and searchable.