Showing posts with label software. Show all posts
Showing posts with label software. Show all posts

Saturday, 25 October 2014

Software application architecture - An overview of major software aspects

Software application architecture (I will deliberately use architecture from now on)  is an aspect that should involve the whole team, from the business owners to the developers and the final users -at least a prototype of them-. I will use the MSDN definition because I find it complete and easy to understand: Software application architecture is the process of defining a structured solution that meets all of the technical and operational requirements, while optimizing common quality attributes such as performance, security, and manageability. It involves a series of decisions based on a wide range of factors, and each of these decisions can have considerable impact on the quality, performance, maintainability, and overall success of the application.

Now that we know it's definition and the usage it has, let's talk about key factors related to architecture:

  • Communication. I'm not just talking about "being available" for answering questions, the business owners must communicate new features required as well as bugs found in the business logic. They must provide detailed and specific descriptions of the process that the developers are going to work. This also apply from the developer to the business side, if the developers find a feature very hard to develop, they must suggest something and make it clear to the business owners, doing so may provide a different way to tackle the problem
  • Documentation. The software system must be documented and described in detail. This documents are the contract that will prevent misunderstands and will help new members of the team understand the system.
  • Keeping a list of concerns, assumptions and expectations. This can help when reviewing the project in the future and understanding the architecture decisions. It's a good idea to keep it organized by subject. For example, divide it in infrastructure considerations, software concerns, business analysis, etc.
  • Create more than one architecture. It would be very hard to have one architecture, ideally you will create more than one with enough detail to start testing and see how things are looking. It's better to do it iteratively and in an incremental way to refine the architecture.
  • Have a due date for completing the architecture. Because architecture involves the whole team, it could take forever to have a "perfect" and approved architecture, but the reality is that we will need to make adaptations because we cannot know everything up front, but we can create an architecture that is ready to handle future changes. So it's a good idea to decide on how much time is the team taking for defining architecture, and start working right away to find issues in an early stage of the project and address them as soon as possible. 
  • Take an active part in the decision making and then follow through!. It would be very important that everybody gets involved according to their role in the project. Once that the decisions are made, they should be followed. For example, if you need a web service for some sort of operation and the team decided that X web service is the right one, then it should be used whenever that operation is required. Also if the architecture requires to do some code files in order to create a process, they should be created whenever a new process is requested. On the administrative side, there is also an effect, if the team decided to use an excel spreadsheet for uploading information, the business side must accept this responsibility and create the required files.
  • Hide details of implementation. When you're working with a software system, it is important to have a good service layer to reveal only what is necessary. Revealing architecture to other systems can be dangerous for security and in the "best case" it can make other developers think a lot on things like: "why have they do that?". Well... that's not the concern of people connecting to your system, they should only know how to obtain exposed data required for other systems.  

Important factors affected by the architecture:
  • Time for adding features. If we got a good architecture, then the new features are pretty much "expected" and they can be delivered on time. This is because we would probably leave the "skeleton" ready for the upcoming features of the system. Besides, when you have a bad architecture, it's really hard to obtain time for re factoring,because it's the most technical aspect of software development, so the other areas involved will not clearly understand the importance of the architecture, so they will not allow much time for re factors.
  • Performance of the system. If we do the right choices, the performance will be the expected. This is related to the entries of performance: Back end and Front end.
  • New people in the team. If there are new business owners or new developers, a good architecture will make the learning path very straight forward, and this will save time and money to the company.
  • Integration with other systems. Most systems nowadays interact with other systems. Having a good architecture (for example, creating a web service layer) will make it easier to interact with other systems, and it's important to see this on the beginning of the project. Doing so will save a lot of time, when this kind of interaction is needed.
  • Bugs. Good architecture leads to less bugs, bad architecture leads to a lot of bugs. That's something easy to understand, because if the architecture is not ready to show good messages whenever you're having a new issue, it's very unlikely that you'll find the reason of the bug, also if the architecture has bar practices like not having a good structure of the project and then creating a lot of methods for the same thing, you'll probably find the same bug repeated in different areas of the system.
  • Value. The architecture plays a very important role in the value of the project. In the end, the expected times for adding features, the performance, the usability, the results and everything related to the system is directly derived from the architecture decisions, and the users will take advantage of the system, if and only if our decisions are appropriate.


It's complicated to give and estimate on how the architecture affects software systems, it depends on a lot of factors and the context of the systems, but I will use a piece of an interesting article to give you an idea:

"It can be hard to measure the cost of software erosion and convey this cost to non-technical people who often have to sanction work to stop software erosion. Even though software erosion causes reduced productivity, reduced quality and increased time-to-market, no one specific point of erosion causes these effects in isolation, rather it is the effect of multiple points of erosion that combine and reinforce each other to cause them.
However, a study by the US Air Force Software Technology Support Centre (STSC) attempted to put some rough measure on the costs of software erosion. The researchers took two versions of a mature software system (50k LOC) and asked two different teams to perform the same maintenance task (adding approx. 3k of code) on their respective version. Version 1 was an existing system suffering software erosion. Version 2 was the same system but with the architecture restructured to remove erosion.
The results were staggeringly different. Team 1, working on Version 1, needed over twice as long as team 2 to complete this relatively short task. Furthermore, Team 1’s results contained more than eight times the number of errors than the work submitted by team 2, working on version2. Erosion in a small system such as this still had the potential to lead to significant problems when the software was maintained."

This is the link to the original article:

http://www.methodsandtools.com/archive/archive.php?id=85

Ok, this is just the tip of the iceberg, but I wanted to share with you, how important is to have a good architecture. My best advice is to do early planning and to have great communication channels between teams, this are the very key factors to success. I hope you're enjoying the series! if you want me to talk about a particular software topic, let me know in the comments.










Friday, 29 August 2014

-Searching- finding like a real pro

Everybody uses search engines, but a big amount of users doesn't know that the search engines have a lot of powerful functionalities for searching, and it's no surprise! usually these functionalities are only known by tech savvy people. I will guide you through tricks that are explained using google, but most functionalities are present in all the search engines, and trust me :P if you don't know them, you're missing like 90% of the power of search engines, so even if you think you're an expert, keep reading! you might find something useful or that you don't know. I'll also include complicated search scenarios and a way to overcome them, because I believe that finding information for some topics can be complicated using the conventional ways.

Let's start with some facts and considerations about searching:
  • Google doesn't care about punctuation, so stop using "," and ".".
  • Keywords are not case sensitive. This means that apple = aPple for google.
  • The search results are affected by your location. This means that if you want to search for something in a place you're going to be on vacation, you  will want to change the location. To do this, on the search results, you can clic on Search tools and then change your location there:
  • The order of the words establish it's importance, so chose it carefully! This also means that the first results are more related to the first word the next results with the first and second word and so on. A good way to find lyrics in google is to set the word lyrics at the beginning and then the phrase or the name of the song. For example, searching for: lyrics "song of myself" will search first results containing lyrics, and then within those results, google will look for "song of myself".
  • Be specific (we will talk about scenarios were this is not the best approach).
  • Google will notify you at the top of the results, when words are being ignored.
And now let's check this search tools and recommendations:

  • Phrases. This is my favourite functionality, you can enclose words with: " to search for phrases, for example, when searching for a song that you don't remember the name, but you do remember the lyrics, you can search for something like: "and salt betrays my eyes again" lyrics.
  • Images. This is also an awesome tool! If you find a picture, and you would like to know more about it (for example, the place were it has been taken) you can save the picture on your desktop and then go to the search images in google, and then click here:                                                                                       
  • That will open a window and you can select the image you want to search. It will show results matching the same picture, and similar images.
  • Searching in a particular web site. Sometimes you know that the information you're looking for is in a web site, but you just don't remember were. For this cases, if you include: site:www.website.com plus the words you're searching for, google will look for results that are only in the web site specified. For example, searching for site:www.rainforest.org trees, will look for the word trees in the web site: www.rainforest.org.
  • Word definitions. If you want to know the definition of a word you can search for define:word. And google will look for a definition (like a dictionary).
  • Or. The word OR helps you search for one term or another. For example, if you want to search for results that contains chocolate or pie, but not both! you can do it by searching for: chocolate OR pie.
  • Wildcard. The "*" character is like the joker card for google. When you use it, google will  match it with any word. This can be very useful, used in combination with phrase searching. For example, when you're searching for the lyrics of a song and you don't remember a complete phrase, This is the result of searching for: lyrics "ever * away with me"             
  • Results of introducing a phone number. Sometimes, when you just have the phone number of a person, you can search for it using google. In order for this to  work properly, you will want to make sure that the results are searched in the location were the phone belongs. 

Now it's time for the cherry of the cake ;) I will give you advise for searching under complicated circumstances, you'll be surprised by it, give it a try when your conventional ways of searching are not producing the expected results:

  • Different pages were your info can be. Suppose that you installed a new version of an operating system and you want to update your drivers to make them work properly. Where are you going to search? usually you'll search for the driver's page and then you'll download the drivers there. But... what will you do if the page is down! are you going to wait until it is up again? For this particular case, you know that most parts of your machine are of another brand different from your computer's brand. So, for example, if your gpu driver is Nvidia, you can go and search for it in the Nvidia's page! or maybe in a page of another brand that also uses the same Nvidia gpu that you've.
  • Searching for a very specific topic. Were did you search when you want to buy something? did you use google? Of course no! you go to some online store and then you search for the item there. The same logic applies to some very specific or complicated topics, for example, when you search for a math problem that is uncommon, it's better search in sites like: http://math.stackexchange.com/.or to make questions there, usually you'll receive a response in less than a day. There are many communities online that are focused on particular topics, usually they've a very good and structured web site with lots of information and search resources. Another thing that you can do, is to search for something more generic, and then take a look at the results, and came with another more particular words to find what you're looking for.
  • Searching for something difficult to describe or for something that you don't know much about. In this case you can also try to search for something more generic, for example, if you saw a recipe for a cake with a very specific name, but you just don't remember the name, you could try searching for cake's recipes, and then get some more context to do a better search (for example, the ingredients, the country's recipe, etc). 
  • About online systems. Are you using online systems (CRM,  RP, school web sites, etc) ? if your answer is yes, remember that you can take a look at the communities of the online system for answers, they'll probably came across the same issue that you need to address.
  • Searching for images. Searching for images can be though, sometimes google image search is not good enough, so if you want to search for a set of images, that are related to some topic, you'll find a lot of resources in tumblr or flickr. Particularly in tumblr, you can find lots of accounts that are related to some topic, for example: http://strictly-mma.tumblr.com/ is a tumblr page were you can find lots of mma related images.


Ok, this post is comming to an end :) My final advise is to use common sense and create your own search heuristic based on your situation. 

I want to thank you for reading, and if you enjoy, please share! If you want me to talk about some software related topic, please let me know in the comments!


Friday, 22 August 2014

Being extremely successful at working remotely

Working remotely can be easy and awesome, you just need to realise that it is way more different in comparison with working in an office and also use a lot of common sense to be effective and successful.

These are some conditions that are -almost- always true when working remotely:

  1. You need to be available for meetings
  2. Answering and reading email is important
  3. You'll need a good internet connection
  4. A second monitor is a must
  5. You'll be at least in one meeting during the day
  6. You'll do less exercise because your home is your new office



I will present recommendations based on the given conditions, but you can always evaluate your own conditions and set up your work rules to be productive:
  1. Stay visible! Make sure that during your work hours you're always reachable. Log into your IM account and stay available during work. I suggest to not spend time messing with the IM client status. Current chat clients have ways to identify if you've been away for a period of time enough to put you in a "away from computer" status. And also, changing your status to "busy" can be bad, why will you change it? if you are going to be really busy, and you're not being available for a period of time, you can log off and let everyone know the reason. On the other hand, if you're again "available" will you remember to change the status again? if you don't, then the members of the team could think that you're busy and they'll not contact you
  2. Have a comfortable and effective work place. Let's talk first about furniture: Make sure that you have a desk with enough room for your hardware requirements. I suggest to have enough room for a laptop and a second monitor, another important piece of furniture, is a comfortable chair, make sure that you don't hurt your back or neck with it. Talking about an effective place, you've to take into account that you're probably being in meetings during the day, so I suggest to have a quiet place or make it quiet with a noise cancelling curtains for example. another important piece for this is a good headset, a "trick" that many people don't know is that you can probably use the headset of your cellphone in your laptop, those devices are usually great, good looking and using them can save money.
  3. Be communicative. Are you about to finish a task? Have you been working a lot with a co worker? Are you changing your lunch schedule? All of these situations needs to be communicated to the team. For example, if you're about to finish a task, you'll probably need to pair with a member for reviewing or actually, your manager will be assigning a new task soon depending on how much time you're planning to spend on the current task. It's a good idea to let the members of the team that are actively working with you know when you're grabbing lunch. 
  4. Be ready for stand up. Prepare a couple of minutes before stand up: check your items, your needs, open the meeting, go to the restroom, bring a cup of tea or coffee (in case you enjoy them!)
  5. Email and chat latency. Set email and chat notifications to "on" and answer them quickly. For chat in less than one minute. For email, well... depends, but ideally in less than 10 minutes, sometimes email can be a little more complex. And also, don't forget to check all the emails you receive,  no matter if they're a general announcement, you'll probably want to know if the office is being closed for a couple of days :)
  6. Schedules. Try to decide on an appropriate schedule. Set your work hours and lunch time and let everyone know. If you're going to change something for a reason, you should always send a message!
  7. Cameras. Yes! video chats are really awesome when working remotely and they're so overrated. Seeing the people of the meeting will help in understanding the point of view of your team, you will feel closer to them and then you'll communicate better. Just give it a try! it really improves overall communication. 
  8. Remote meeting tools. Try to use as much as possible tools like sharing screen, drawing in the screen, letting other person take control of your computer. Record your meetings. These tools will help in being more productive and will improve communication.
  9. Set rules based on your own context. Talk with everybody on your team and set the appropriate rules for your team. For example, if a member of the team is arriving earlier than everyone, he could probably do the tasks of database maintaining.
  10. The other side of the mirror. For those people on the team working in the office, remember that some rules also apply to you. For example, if you're working closely with someone, it  would be a good idea to let them know about your meetings and the times when you're going to be unavailable, remember that the remote team members cannot go to your place and see that you're not in your spot. In general, it's a good practice to set up a calendar visible to every member of the time with the available and unavailable times of everyone.
  11. Do more exercise!  Trust me... you'll gain some weight because you'll be doing much less exercise, so this is the right time to attend some kick boxing classes and stay in shape! -ok just kidding, but really, try to do exercise, running, hiking, martial arts, yoga, gym, whatever you decide-

As I've already say,  these recommendations are based on my experience, every team should sit and dedicate time in creating their own particular rules, these will make them more productive.

I hope you enjoy these entry! feel free to leave your comments at the end of the post.