Sachverhalt:
A. A.a Im Eheschutzverfahren vor dem Eheschutzrichter des Bezirks Bülach schlossen X._ (Beschwerdeführer; geb. ***1967) und Y._ (Beschwerdegegnerin; geb. ***1967) am 9. Februar 2005 eine Vereinbarung ab. Demnach nahmen sie per 1. März 2005 auf unbestimmte Dauer das Getrenntleben auf. Der Sohn, Z._ (geb. ***1996), wurde unter die Obhut der Mutter gestellt. Das eheliche Einfamilienhaus wurde der Beschwerdegegnerin zur alleinigen Benützung zugewiesen. Der Beschwerdeführer verpflichtete sich, der Beschwerdegegnerin monatliche Unterhaltsbeiträge von insgesamt Fr. 9'200.-- zu bezahlen, nämlich Fr. 8'200.-- für sie persönlich und Fr. 1'000.-- für Z._. Schliesslich vereinbarten die Parteien (neben weiteren Regelungen), dass der Beschwerdeführer die Kosten für den Hypothekarzins des Einfamilienhauses vom Unterhaltsbeitrag in Abzug bringen dürfe, soweit er dafür aufkomme. Diese Vereinbarung basierte auf einem monatlichen Nettoeinkommen des als Informatiker selbständigerwerbenden Beschwerdeführers von Fr. 17'000.--.
A.b Am 28. Juni 2005 reichte der Beschwerdeführer beim Eheschutzrichter des Bezirks Bülach ein Abänderungsbegehren ein, insbesondere weil seine bisherige faktisch einzige Auftraggeberin das Auftragsverhältnis mit Wirkung per 30. Juni 2005 aufheben wolle und er wesentlich weniger verdienen werde und auch bereits in den ersten vier Monaten 2005 weniger verdient habe als das Einkommen, das Basis der Unterhaltsbeiträge sei. Mit Verfügungen vom 17. November 2006 gewährte der Eheschutzrichter der Beschwerdegegnerin die unentgeltliche Rechtspflege, wies das Begehren des Beschwerdeführers auf Umteilung der Obhut über Z._ ab, verpflichtete den Beschwerdeführer in teilweiser Abänderung der Vereinbarung vom 9. Februar 2005, der Beschwerdegegnerin folgende monatliche Unterhaltsbeiträge zu bezahlen: vom 1. Juli bis 31. Dezember 2005 Fr. 3'610.--, nämlich Fr. 1'200.-- für Z._ und Fr. 2'410.-- für die Beschwerdegegnerin persönlich, und ab 1. Januar 2006 Fr. 3'880.-- für beide Unterhaltsberechtigten zusammen.
B. Gegen diese Verfügung erhob der Beschwerdeführer Rekurs und die Beschwerdegegnerin Anschlussrekurs beim Obergericht des Kantons Zürich. Mit Beschluss vom 23. Juli 2007 verpflichtete das Obergericht (I. Zivilkammer) den Beschwerdeführer in Abänderung der eheschutzrichterlichen Verfügung vom 9. Februar 2005 zur Leistung von monatlichen Unterhaltsbeiträgen von Fr. 6'825.-- vom 1. Juli bis 31. Dezember 2005, von Fr. 6'345.-- vom 1. Januar bis 30. April 2006, von Fr. 5'810.-- vom 1. Mai 2006 bis 28. Februar 2007 und von Fr. 5'420.-- ab 1. März 2007 für die Beschwerdegegnerin persönlich sowie jeweils zuzüglich Fr. 1'200.-- für den Sohn Z._.
C. Die vom Beschwerdeführer beim Kassationsgericht des Kantons Zürich eingereichte Nichtigkeitsbeschwerde blieb ohne Erfolg. Mit Zirkulationsbeschluss vom 30. Juni 2008 wurde das Rechtsmittel abgewiesen, soweit darauf eingetreten werden konnte.
D. Gegen den Entscheid des Kassationsgerichts hat der Beschwerdeführer am 5. August 2008 beim Bundesgericht Beschwerde in Zivilsachen eingereicht. Er beantragt, der angefochtene Entscheid sei insoweit aufzuheben, als die Unterhaltsbeiträge ab dem 1. Januar 2006 betroffen seien. Gleichzeitig sei der Beschwerdeführer zu verpflichten, der Beschwerdegegnerin in Abänderung von Ziff. 4 der Verfügung des Einzelrichters des Bezirksgerichts Bülach vom 9. Februar 2005 mit Wirkung ab 1. Januar 2006 einen Unterhaltsbeitrag von insgesamt Fr. 3'485.--, nämlich Fr. 2'485.-- für diese persönlich und Fr. 1'000.-- für den Sohn Z._ zu bezahlen, zuzüglich allfällige vertragliche oder gesetzliche Kinderzulagen. Sofern und soweit der Beschwerdeführer für den Hypothekarzins (exkl. Amortisation) des Einfamilienhauses aufkomme, seien die Unterhaltsbeiträge als getilgt zu betrachten. Er beantragt ferner, eventualiter sei der Entscheid der Vorinstanz zu kassieren und zu neuer Beurteilung an das Obergericht des Kantons Zürich, subeventualiter an das Bezirksgericht Bülach zurückzuweisen. Ferner ersucht der Beschwerdeführer um Gewährung der unentgeltlichen Rechtspflege.
Mit Verfügung des Präsidenten der II. zivilrechtlichen Abteilung vom 7. August 2008 wurde das Gesuch um aufschiebende Wirkung abgewiesen.
Es wurden keine Vernehmlassungen eingeholt.

Erwägungen:
1. 1.1 Die Sache betrifft die gerichtliche Änderung von Massnahmen im Sinne von <ref-law> und dabei ausschliesslich die Festsetzung der Geldbeiträge, die der eine Ehegatte dem anderen während des Getrenntlebens schuldet (<ref-law>), sowie die Unterhaltspflicht des Beschwerdeführers gegenüber seinem Sohn (<ref-law>). Es liegt damit eine Zivilsache (<ref-law>) und eine vermögensrechtliche Angelegenheit vor, wobei der Streitwert mindestens Fr. 30'000.-- betragen muss (Art. 74 Abs. 1 lit. b in Verbindung mit Art. 51 Abs. 1 und 4 BGG). Entschieden hat das Kassationsgericht als letzte kantonale Instanz (<ref-law>). Gemäss dem angefochtenen Urteil beträgt der Streitwert Fr. 184'620.--, nach Auffassung des Beschwerdeführers Fr. 139'270.--. Die gesetzliche Streitwertgrenze wird so oder anders bei weitem überschritten.
1.2 Eheschutzentscheide gelten nach der Rechtsprechung als vorsorgliche Massnahmen im Sinne von <ref-law> (<ref-ruling> E. 5), so dass nur die Verletzung verfassungsmässiger Rechte geltend gemacht werden kann. Deshalb gelangen die Art. 95 und 97 BGG und auch <ref-law> nicht zur Anwendung. Die hier gegebenen Verhältnisse entsprechen denjenigen bei der subsidiären Verfassungsbeschwerde (<ref-law>). Wie dort (Art. 118 Abs. 2 i.V.m. <ref-law>) kommt eine Berichtigung oder Ergänzung der Sachverhaltsfeststellungen ebenfalls hier nur dann in Frage, wenn die kantonale Instanz verfassungsmässige Rechte verletzt hat. Wird Letzteres geltend gemacht, ist neben der Erheblichkeit der gerügten Tatsachenfeststellung für den Ausgang des Verfahrens klar und detailliert darzutun, inwiefern diese verfassungswidrig, insbesondere willkürlich (<ref-law>), offensichtlich unhaltbar sein soll, d.h. mit der tatsächlichen Situation in klarem Widerspruch stehe, auf einem offenkundigen Versehen beruhe oder sich sachlich in keiner Weise rechtfertigen lasse (<ref-ruling> E. 6 S. 397; <ref-ruling> E. 1.3 S. 261 f.; <ref-ruling> E. 2 S. 86; <ref-ruling> E. 4b S. 40, mit Hinweisen). Demnach prüft das Bundesgericht auch weiterhin nur klar und einlässlich erhobene und, soweit möglich, belegte Rügen. Hingegen tritt es auf rein appellatorische Kritik am angefochtenen Entscheid nicht ein. Macht der Beschwerdeführer eine Verletzung des Willkürverbotes geltend, muss er anhand des angefochtenen Entscheides im Einzelnen darlegen, inwiefern dieser im Ergebnis an einem qualifizierten Mangel leidet (<ref-ruling> E. 4.1, mit Hinweisen).
1.3 Verweise auf Rechtsschriften des kantonalen Verfahrens sind unzulässig (<ref-ruling> E. 3.2 S. 400). Das Gleiche gilt auch für die zahlreichen Hinweise auf die Beilagen zur vorliegenden Beschwerde, soweit nicht dargelegt wird, dass es sich um ein zulässiges Novum handelt (<ref-law> in Verbindung mit <ref-law>; zur Unzulässigkeit von neuen tatsächlichen und rechtlichen Vorbringen: <ref-ruling> E. 2 S. 639/640).
2. Der Beschwerdeführer wirft der Vorinstanz eine Verletzung von <ref-law> und des Gebots von Treu und Glauben im Sinne von <ref-law> vor, weil sie von ihm offerierte Beweise nicht abgenommen und Zeugen nicht einvernommen habe mit Bezug auf die Frage, wie gross der mit der A._ Ltd. vereinbarte Stundenansatz gewesen sei. Sodann beruft sich der Beschwerdeführer in diesem Zusammenhang auf die Offizial- und Untersuchungsmaxime.
2.1 Die Vorinstanz hat zum Untersuchungsgrundsatz bemerkt, es sei zutreffend, dass dieser zur Anwendung gelange, wie das Obergericht ausgeführt habe. Das Kassationsgericht hat dazu in der Hauptsache festgehalten, ungenügend sei die von Amtes wegen vorzunehmende Sachaufklärung des Gerichts, wenn ein Sachverhalt unerforscht bleibe, dessen Klärung sich nach Lage der Akten aufdrängen müsste. Das Gericht habe von Amtes wegen zu prüfen, ob die Zugeständnisse der Parteien wahr und ihre Tatsachenbehauptungen vollständig seien. Bleibe eine rechtserhebliche Tatsache beweislos, so sei aber auch unter der Herrschaft der Offizialmaxime zu Ungunsten der Partei zu entscheiden, welche die Beweislast trage (GULDENER, Schweizerisches Zivilprozessrecht, 3. Aufl., Zürich 1979, S. 169; <ref-ruling>). Die Pflicht einer Partei, das Gericht aktiv über den Sachverhalt zu orientieren und ihm die verfügbaren Beweismittel zu nennen, dränge sich umso mehr auf, wenn diese als Schuldnerin eine Herabsetzung des von ihr geschuldeten Unterhaltsbeitrages erreichen wolle. Der Beschwerdeführer sei anwaltlich vertreten gewesen. Es habe in seinem Interesse gelegen, dem Gericht alle ihm verfügbaren Unterlagen einzureichen, um seine Behauptungen seines Einkommenrückgangs und seines tatsächlichen Einkommens glaubhaft zu machen. Der Beschwerdeführer sei bereits in der Vorladung vom 5. Juli 2005 zur einzelrichterlichen Verhandlung vom 8. September 2005 darauf aufmerksam gemacht worden, dass er Unterlagen über seine Einkommens- und Vermögenssituation einzureichen und sämtliche Beweismittel spätestens in der Verhandlung vorzulegen habe.
2.2 Die Vorinstanz hat unter Hinweis auf die Praxis des Bundesgerichts (<ref-ruling> E. 3.2.1 und 3.2.2 S. 412 ff.) zu Recht darauf hingewiesen, dass die Untersuchungsmaxime die Parteien nicht von einer aktiven Mitwirkung am Verfahren entbindet. Dem ist weiter beizufügen, dass der Richter nicht verpflichtet ist, auf alle Beweismittel zu reagieren. Demnach ist er nicht gehalten weitere Nachforschungen anzustellen, sofern er sich bereits aufgrund der erbrachten Beweise ein Bild hat machen können (PETER BREITSCHMID, Basler Kommentar, ZGB I, 3. Aufl., N. 1 zu <ref-law>, S. 912 mit Hinweis auf das Urteil des Bundesgerichts vom 23. Mai 2005 [5C.22/2005], E. 2.2, publiziert in FamPra.ch 2005, S. 950).
2.3 Der im ordentlichen Verfahren geltende Grundsatz, dass die Weigerung zur Erteilung von Auskünften bei der Beweiswürdigung berücksichtigt werden kann, gilt sinngemäss auch im summarischen Eheschutzverfahren. Weigert sich ein Ehegatte, die erforderlichen Auskünfte zu erteilen und die nötigen Urkunden vorzulegen, riskiert er, dass seine Sachdarstellung unglaubwürdig wird (Verena Bräm/Franz Hasenböhler, Zürcher Kommentar, N. 28 zu <ref-law>, S. 458). Die Auskunftspflicht umfasst somit alles, was nötig ist, um die finanziellen Verhältnisse des einen Ehegatten zu beurteilen, die als Grundlage für die Festlegung eines konkreten Anspruchs des anderen Ehegatten wichtig sind. Es besteht ein Anspruch, gegebenenfalls im Einzelnen und genau über das Einkommen Auskunft zu erteilen. Auskunftsverweigerung oder Erteilung ungenügender oder unrichtiger Auskunft kann bei der Beweiswürdigung berücksichtigt werden mit der Folge, dass das Gericht zur Überzeugung gelangt, die Behauptungen des Ehegatten, der seiner Auskunftspflicht nicht oder nicht umfassend nachgekommen ist, seien ganz oder teilweise falsch, bzw. den Angaben des anderen Ehegatten sei zu glauben (<ref-ruling> E. 3a S. 29).
Sowohl das Obergericht wie das Kassationsgericht haben befunden, der Beschwerdeführer habe seine Offenbarungspflicht betreffend seine Einkünfte verletzt (E. 3.1 nachfolgend).
Sowohl das Obergericht wie das Kassationsgericht haben befunden, der Beschwerdeführer habe seine Offenbarungspflicht betreffend seine Einkünfte verletzt (E. 3.1 nachfolgend).
2.4 2.4.1 Der Beschwerdeführer macht geltend, die Vorinstanzen hätten die von ihm "zumindest eventualiter bzw. sinngemäss" beantragten Beweise gemäss den Angaben der Beschwerdegegnerin wie auch die Befragung von Zeugen abnehmen müssen. Er verweist dabei auf die Anschlussrekursantwort. Darin wird ausgeführt, dass er an sich nichts gegen die Einholung von schriftlichen Auskünften bei den von der Beschwerdegegnerin beantragten Personen einzuwenden habe, wenn sich damit das seit bereits über eineinhalb Jahren hängige vorliegende Verfahren wesentlich vereinfachen lassen sollte. Er sei jedoch klar der Ansicht, dass eine weitere Ausdehnung und Verlängerung des Verfahrens vorliegend nicht gerechtfertigt sei und sich bei der bestehenden Sachlage die (Beweis)Abnahmen grundsätzlich nicht aufdrängten. Wenn der Beschwerdeführer nun vorträgt, seine Abklärungen bei der eigentlichen Auftraggeberin, der B._ Ltd. bzw. Herrn W._ und der zwischengeschalteten Firma C._, vertreten durch Frau V._, hätten keine weiteren Erkenntnisse ergeben, übt er lediglich unzulässige appellatorische Kritik am Vorwurf der Vorinstanz, er habe seine Mitwirkungs- bzw. Auskunftspflicht verletzt. Das Gleiche gilt auch für das Vorbringen, nach Treu und Glauben habe er jederzeit darauf vertrauen dürfen, dass nur die Frage einer Thesaurierung seiner effektiven Einkünfte in der A._ zur Diskussion gestanden habe, weshalb er schlicht keinen Anlass gesehen habe, weitere Auftragsabrechnungen und/oder Kontoauszüge seines Geschäftskontokorrents vorzulegen. Auf diese Vorbringen kann nicht eingetreten werden (E. 1.2 hiervor).
2.4.2 Im angefochtenen Urteil wurde ferner erwogen, der Beschwerdeführer habe gestützt auf die Verfahren vor dem erstinstanzlichen Richter gewusst, dass er seine Behauptungen der Einkommensverminderungen glaubhaft machen müsse und dazu sämtliche ihm vorliegenden zur Glaubhaftmachung geeigneten Dokumente einzureichen und entsprechende Erläuterungen dazu abzugeben habe. Ferner sei das Obergericht begründet davon ausgegangen, dass Beträge in der eingereichten Erfolgsrechnung des Beschwerdeführers nicht erfasst worden seien und nicht glaubhaft sei, dass er (wie verbucht und wie von ihm behauptet) auf Darlehen von der Firma D._ angewiesen gewesen sei und solche in Anspruch genommen habe. Unter diesen Umständen sei die Vorinstanz in haltbarer Weise davon ausgegangen, dass der Beschwerdeführer Dokumente in seinem Besitz habe, welche er nicht eingereicht habe und dies nicht aus Unkenntnis, sondern weil er sie nicht habe einreichen wollen, weshalb Nachforschungen des Gerichts bei ihm wohl keine anderen Erkenntnisse gebracht hätten.
Dagegen wendet der Beschwerdeführer lediglich ein, die Veränderung der Buchhaltungspraxis im Jahre 2005 sei vorliegend nicht mehr Streitthema und treffe erst recht bezüglich des Einkommens ab 1. Januar 2006 schlicht nicht zu. Mit diesen Argumenten setzt sich der Beschwerdeführer nicht mit der Erwägung des Kassationsgerichts auseinander, weshalb auch darauf nicht eingetreten werden kann.
2.4.3
2.4.3.1 Der Beschwerdeführer ist der Ansicht, er habe darauf vertrauen dürfen, dass das Gericht keine gänzlich andere Beurteilung der Verträge vornehmen werde, als dies die Parteien der Dispositions- und Eventualmaxime entsprechend dem Gericht im Verlaufe des Verfahrens vorgetragen hätten. Insbesondere die Auslegung der Verträge mit einer angeblich möglichen (und versteckten) Erfolgsbeteiligung trotz mangelnden Nachweises einer Thesaurierung des effektiven Bruttoeinkommens habe ohne vorherige Informationen von Seiten des Gerichts von niemandem erwartet werden müssen.
Der Vorwurf geht fehl, und es kann offen gelassen werden, ob die Beschwerde diesbezüglich den Begründungsanforderungen genügt. Das Obergericht sah sich namentlich deshalb dazu veranlasst, die Verträge des Beschwerdeführers mit seinen Auftraggebern auszulegen, weil er keine Kontoauszüge über Eingänge/Vergütungen für Leistungen im Jahr 2006 dem Gericht vorgelegt hatte. Zudem hatte dieses angesichts des Umstandes, dass auch der Kinderunterhalt zur Beurteilung stand, die Offizialmaxime zu beachten.
2.4.3.2 Sodann rügt der Beschwerdeführer, bei dieser Sachlage habe das Kassationsgericht das rechtliche Gehör im Sinne von <ref-law> verletzt, weil es die Verantwortlichen der A._, der B._ Ltd. oder der C._ nicht als Zeugen habe einvernehmen lassen. Nach dem Ausgeführten (E. 2.4.1 hiervor) hätte der Beschwerdeführer allen Grund gehabt, solche Beweisanträge schon in der Rekursantwort klar und deutlich zu stellen, wobei auch hier zu erwähnen ist, dass er zur Mitwirkung bzw. Erteilung von Auskünften verpflichtet ist. Eine Verfassungsverletzung liegt nicht vor, denn es kann davon ausgegangen werden, dass die beantragten Zeugen mit ihren Aussagen lediglich das vom Beschwerdeführer Behauptete bestätigt hätten. Das geht denn auch aus der schriftlichen Auskunft von Frau U._ vom 30. Juli 2008 (Beschwerdebeilage 6) hervor, welches Schreiben allerdings ein echtes Novum darstellt und daher unbeachtlich ist (vorne E. 1.3; <ref-ruling> E. 2.1).
2.4.4 In diesem Zusammenhang rügt der Beschwerdeführer, sein Anspruch auf Vertrauensschutz nach <ref-law> sei verletzt worden. Es kann auch hier offen gelassen werden, ob der Vorwurf den Begründungsanforderungen genügt, denn er stösst ins Leere. Der Beschwerdeführer rechtfertigt seinen Anspruch damit, er habe darauf vertrauen dürfen, dass die Verträge mit der A._ genügend klar formuliert worden seien und dass höchstens die Frage der von der Gegenseite behaupteten Thesaurierung bzw. seiner angeblich möglichen (und versteckten) Erfolgsbeteiligung gestellt werden könnte.
Der in <ref-law> verankerte Grundsatz von Treu und Glauben verleiht einer Person Anspruch auf Schutz des berechtigten Vertrauens in behördliche Zusicherungen oder sonstiges, bestimmte Erwartungen begründendes Verhalten der Behörden. Vorausgesetzt ist weiter, dass die Person, die sich auf Vertrauensschutz beruft, berechtigterweise auf diese Grundlage vertrauen durfte und gestützt darauf nachteilige Dispositionen getroffen hat, die sie nicht mehr rückgängig machen kann (<ref-ruling> E 4.1 S. 170). Die Meinung des Beschwerdeführers, er habe darauf vertrauen dürfen, dass die Abklärungen betreffend sein Einkommen auf die Frage der Thesaurierung beschränkt sei, geht fehl. Dass er verpflichtet sei, seine Einkommensverhältnisse offen zu legen und glaubhaft zu machen, musste ihm - wie ausgeführt - bekannt sein. Bestand somit trotz Geltung der Untersuchungsmaxime eine Mitwirkungspflicht seinerseits, so konnte von einer Entlastung seiner Beweisführungspflicht keine Rede sein. Zudem ist der Beschwerdeführer - wie die staatlichen Organe - selbst gehalten, nach Treu und Glauben zu handeln (<ref-law>).
2.4.5 Schliesslich rügt der Beschwerdeführer eine Gehörsverletzung, weil die Vorinstanz seine Vorbringen in seiner Anschlussrekursantwort nicht beachtet habe, wonach in der Programmierungsumgebung Delphi nicht die früheren Stundenansätze erzielt werden könnten, und dass andere externe Mitarbeiter ebenfalls nicht mit mehr als Fr. 70.-- brutto rechnen könnten.
Das Kassationsgericht hat dazu erwogen (S. 31 Ziff. 16), das Obergericht habe die Anschlussrekursantwort durchaus zur Kenntnis genommen. Wenn es in seinen Erwägungen zum Stundenansatz für Arbeitsstunden des Beschwerdeführers ab Januar 2006 nicht explizit auf dessen Ausführungen eingegangen sei, so nicht deshalb, weil es diese missachtet hätte, sondern weil es von einem ganz anderen Ausgangspunkt ausgegangen sei, nämlich mangels Glaubhaftmachung einer Änderung vom Stundenansatz, den der Beschwerdeführer seiner früheren Auftraggeberin habe in Rechnung stellen können.
Mit dem blossen Argument, es sei gerichtsnotorisch, dass sich im IT-Bereich nicht mehr gleich viel verdienen lasse, denn generell würden externe (selbständige) Mitarbeiter wie der Beschwerdeführer gar nur noch zwischen Fr. 50.-- bis Fr. 90.--/h erzielen können, kann keine Verletzung der Begründungspflicht dargetan werden. Das Kassationsgericht hat auf den Beschluss des Obergerichts verwiesen und dessen Erwägungen kritisiert der Beschwerdeführer denn auch unter dem Gesichtspunkt der Willkür (Nachfolgend: E. 3.3). Konnte der Beschwerdeführer den Entscheid vorliegend sachgerecht anfechten, liegt keine Verletzung von <ref-law> vor (dazu: <ref-ruling> E. 3.3 S. 445).
3. Der Beschwerdeführer macht ferner geltend, weil die Vorinstanz den in den Einsatzverträgen erwähnten Bruttostundenansatz von Fr. 70.-- ab 1. Januar 2006 nicht als glaubhaft angesehen habe, sei das Willkürverbot missachtet worden.
3.1 Im angefochtenen Entscheid wird dazu ausgeführt, der Beschwerdeführer habe am 1. Dezember 2005 als "Auftragnehmer" mit der A._ einen Rahmenvertrag über die Erbringung von Dienstleistungen abgeschlossen. Gleichzeitig hätten die Vertragspartner einen Einsatzvertrag als Anhang zum Rahmenvertrag abgeschlossen. Gemäss diesen Abmachungen solle offenbar der Beschwerdeführer (bzw. seine Einzelfirma "X._ Informatik") als Auftragnehmer der A._ bei einer sogenannten Einsatzfirma Dienstleistungen erbringen. Nach der Behauptung des Beschwerdeführers besteht ein einziger Einsatzvertrag, nach welchem der Beschwerdeführer im Auftrag der A._ Informatik-Dienstleistungen bei der Firma B._ Ltd. zu erbringen habe. Nach dem Rahmenvertrag solle die Honorierung des Beschwerdeführers nach den effektiv von ihm geleisteten und von der Einsatzfirma anerkannten Arbeitsstunden zu einem (im Rahmenvertrag nicht definierten) Nettostundenansatz zuzüglich Mehrwertsteuer erfolgen. Sodann sehe der Rahmenvertrag zwei Varianten bezüglich "Risikoverteilung" vor, von denen der Beschwerdeführer eine habe auswählen können. Diese Varianten würden wie folgt lauten:
Variante I:
Normale Regelung: Der Auftragnehmer tritt das Unternehmerrisiko vollständig an die A._ ab. Die Marge der A._ beträgt 33 % vom Verkaufsstundensatz, jedoch mindestens Fr. 25.-- pro geleistete Arbeitsstunde.
Variante II:
Spezielle Regelung: Es gilt eine Kommission von 20 % vom Verkaufsumsatz, jedoch mindestens Fr. 20.-- pro geleistete Arbeitsstunde. Das Risiko der Zahlung trägt somit der Auftragnehmer selbst (Unternehmerrisiko), wie unter Ziff. 8.1 und Ziff. 11 erwähnt.
Im Einsatzvertrag sei unter dem Titel Honorar als "Einkauf" ein Betrag von Fr. 70.-- aufgeführt worden. Unter dem Titel Unternehmerrisiko seien die vorzitierten beiden Varianten wiederholt worden, wobei in Variante II "mindestens Fr. 20.--" durch "mindestens Fr. 25.--" ersetzt und die Variante II angekreuzt worden sei.
Das Kassationsgericht fährt fort, der erstinstanzliche Einzelrichter sei davon ausgegangen, dass der Beschwerdeführer von der A._ Fr. 70.-- pro Stunde zuzüglich eine Kommission von 20 % vom Verkaufsumsatz, jedoch mindestens Fr. 25.-- pro geleistete Arbeitsstunde erhalte. Das Obergericht habe jedoch erwogen, die Annahme, bei der im Einsatzvertrag enthaltenen Kommission handle es sich um eine Beteiligung des Beschwerdeführers, sei nicht einsichtlich. Die so interpretierte Regelung wäre nämlich (je nach Stundenansatz) trotz Risikoüberwälzung auf den Auftragnehmer für diesen weniger günstig, als diejenige, wonach die A._ das Unternehmerrisiko trage und trotzdem nur eine Marge von 33 % vom Verkaufsstundenansatz erhalte. Nach der Auslegung des Obergerichts trage der Beschwerdeführer das Risiko der Zahlung, d.h. die Nicht-Vergütung geleisteter Arbeitsstunden, weshalb die Marge/Kommission der A._ (im Gegensatz zum erstinstanzlichen Richter, der von einer Kommission des Beschwerdeführers ausgegangen sei) entsprechend tiefer ausfalle. Bei höheren Stundenansätzen, wie sie der Beschwerdeführer der früheren Auftraggeberin E._ AG in Rechnung gestellt habe (Fr. 135.-- zuzüglich 7.6 % MwSt.), verbleibe selbst nach Abzug der Beteiligung der A._ (20 %, somit Fr. 27.--) ein das vertragliche Honorar des Beschwerdeführers (Fr. 70.--) übersteigender Anteil (Fr. 38.--). Die Regelung, wonach der Beschwerdeführer das Unternehmerrisiko trage, könne daher nicht anders ausgelegt werden, als dass er - je nach Ansatz - am Ertrag pro geleistete Arbeitsstunde beteiligt sei. Die Vertragsklausel wäre jedenfall nicht nachvollziehbar, wenn das Honorar des Beschwerdeführers auf Fr. 70.-- fixiert und gleichzeitig die Beteiligung der A._ variabel wäre, ansonsten eine allfällige keiner Vertragspartei zugeordnete Differenz zwischen der Beteiligung der A._ und dem fixen Honorar des Beschwerdeführers resultieren könnte. Da der Beschwerdeführer zum Nachweis seines Einkommens ab Januar 2006 einzig an die A._ adressierte Rechnungen über die von ihm geleisteten Arbeitsstunden zu einem Stundenansatz von Fr. 70.-- eingereicht habe, sei der Schluss auf das von ihm tatsächlich erwirtschaftete Bruttoeinkommen nach den vorstehenden Ausführungen nicht möglich. Das gelte umso mehr, als er es unterlassen habe, für das Jahr 2006 soweit möglich, Kontoauszüge über die bei ihm eingegangenen Vergütungen einzureichen. Weiter seien den Rechnungen an die A._ entgegen der Vereinbarung im Rahmenvertrag keine von der Einsatzfirma unterschriftlich anerkannten Arbeitsrapporte beigelegt worden. Der Beschwerdeführer hätte - so das Obergericht - allen Grund gehabt, seine angeblich prekäre finanzielle Situation mit sämtlichen hierfür geeigneten Dokumenten offen zu legen. Seine Beweismittel seien aber unvollständig oder unklar bzw. zumindest auslegungsbedürftig. Vor dem Hintergrund, dass er bereits für das Jahr 2005 einen unvollständigen Geschäftsabschluss eingereicht habe, erscheine in Anbetracht der auslegungsbedürftigen Honorarregelung ein Einkommen von Fr. 70.-- pro geleistete Arbeitsstunde nicht glaubhaft. Vielmehr bleibe nach den eingereichten Verträgen Raum für eine Erfolgsbeteiligung. Dabei sei vom Stundenansatz auszugehen, den der Beschwerdeführer einer früheren Arbeitgeberin, der E._ AG auch noch für die Arbeiten im Oktober / November 2005 habe in Rechnung stellen können, nämlich Fr. 135.--. Dass sich daran etwas verändert haben könnte, sei nicht glaubhaft gemacht worden. Der Stundenansatz des Beschwerdeführers sei somit auf Fr. 108.-- zu veranschlagen, nämlich Fr. 135.-- abzüglich der Beteiligung der A._ von 20 %.
3.2 Der Beschwerdeführer macht geltend, die Einsatzverträge mit der expliziten Nennung des Honoraransatzes von Fr. 70.-- pro geleisteter Arbeitsstunde würden seine - lediglich glaubhaft zu machende - Tatsachenbehauptung für das effektive Bestehen eines solchen Bruttostundenansatzes belegen. Indem auch das Kassationsgericht vom Beschwerdeführer die Vorlage weiterer Unterlagen verlangt habe, so gehe dies bei Weitem über ein blosses Glaubhaftmachen des Bestehens des vom Beschwerdeführer angeführten Honoraransatzes hinaus. Somit hätte er gemäss der Auffassung des Kassationsgerichts einerseits während des schon während mehrerer Jahre dauernden Verfahrens laufend weitere Abrechnungen sowie Kontoauszüge vorlegen und damit eine weitere Verfahrensverzögerung riskieren sollen bzw. andererseits gar den direkten Beweis des Bestehens einer definitiven Honorarvereinbarung erbringen müssen. Auf diese und die weitere - bloss appellatorische - Kritik am angefochtenen Entscheid kann nicht eingetreten werden. Der Beschwerdeführer räumt mit seinen Einwendungen selbst ein, dass er im kantonalen Verfahren angehalten wurde, namentlich Kontoauszüge über Eingänge/Vergütungen für Leistungen im Jahr 2006 vorzulegen. Dagegen begnügte er sich, nicht visierte Arbeitsrapporte sowie den nicht unterzeichneten, kopierten Beleg über die mehrwertsteuerpflichtigen Leistungen für das 1. Quartal 2006 einzureichen.
3.3 Das Kassationsgericht hat zum mutmasslichen Einkommen des Beschwerdeführers - zusammengefasst - ausgeführt, es sei nicht einzusehen, weshalb er mit der A._ einen festen Stundenansatz von Fr. 70.-- vereinbart habe, wenn doch zwei verschiedene Varianten (mit Abtretung des Unternehmerrisikos oder mit Übernahme des Zahlungsrisikos) zur Wahl gestanden hätten. Überdies habe der Beschwerdeführer in seiner Beschwerde vor den Vorinstanzen nicht etwa nachgewiesen, dass er Fr. 70.--/h zuzüglich MwSt. ausbezahlt erhalten habe, sondern lediglich, dass er dafür Rechnung gestellt habe. Damit sei jedoch kein Schluss auf sein tatsächliches Bruttoeinkommen möglich. Nach der angekreuzten Variante II stehe dem Beschwerdeführer die Entschädigung zu, welche die B._ Ltd. der A._ für die Arbeitsleistungen des Beschwerdeführers zu bezahlen habe, abzüglich 20 %, mindestens aber (abzüglich) Fr. 25.-- pro Arbeitsstunde. Um der A._ Rechnung zu stellen, hätte der Beschwerdeführer also wissen müssen, was die B._ Ltd. der A._ tätsächlich für seine Arbeitsleistung bezahlt habe. Wenn ihm dies aber zur Zeit seiner Rechnungsstellungen vom Januar 2006 an die A._ noch nicht bekannt gewesen sei, könnten diese Rechnungsstellungen höchstens als Akonto- oder Teilzahlungsrechnungen verstanden werden, da für definitive Rechnungen nach Vertrag ja eine notwendige Grundlage gefehlt habe, nämlich die Kenntnis des Verkaufsumsatzes, nach welchem sich gemäss angekreuzter Variante II die Entschädigung des Beschwerdeführers gerichtet habe. Da die Behauptung eines Einkommens von Fr. 70.--/h nicht glaubhaft gemacht geworden sei, sei das Obergericht vom Stundenansatz ausgegangen, den er seiner früheren Auftraggeberin in Rechnung habe stellen können, da nicht glaubhaft gemacht worden sei, dass sich daran etwas verändert haben könnte. Weil kein tieferer Stundenansatz dargelegt worden sei, habe es dem Beschwerdeführer den der früheren Auftraggeberin in Rechnung gestellten Stundenansatz angerechnet.
Der Beschwerdeführer setzt sich mit diesen Argumenten nicht auseinander. Er bringt dagegen vor, der Schluss, er habe seinen Honoraransatz nicht glaubhaft gemacht, sei unhaltbar, denn er sei mit der tatsächlichen Situation auf dem Arbeitsvermittlungsmarkt und den Stundenansätzen von externen Delphi-Mitarbeitern absolut unvereinbar. Die auch hier angeführte Bestätigung der A._ vom 30. Juli 2008 ist als echtes Novum unzulässig. Unbehelflich ist auch der Einwand, selbst wenn die Verträge einen gewissen Interpretationsspielraum in Bezug auf eine Erfolgsbeteiligung ermöglichten, müsste dies zum einen - wegen Verletzung des rechtlichen Gehörs sowie des Vertrauensschutzes - zuerst noch näher abgeklärt werden und zum andern hätte allerhöchstens von einem durchschnittlichen und marktüblichen Stundenansatz eines externen Programmierers mit Delphi-Kenntnissen ausgegangen werden dürfen. Wie ausgeführt, konnten die Vorinstanzen auf weitere Abklärungen verzichten, da der Beschwerdeführer sich nicht veranlasst sah, Kontoauszüge über die Vergütungen im Jahr 2006 vorzulegen. Denn es lag offensichtlich eine Auskunftsverweigerung vor, welche die Richter gemäss der Rechtsprechung des Bundesgerichts bei der Beweiswürdigung in Bezug auf die Vertragsauslegung berücksichtigen durften. Im Übrigen ist eine materielle Rechtsverweigerung nicht schon dann gegeben, wenn eine andere Lösung ebenfalls vertretbar oder gar zutreffender erschiene, sondern nur dann, wenn das Ergebnis schlechterdings mit vernünftigen Gründen nicht zu vertreten ist (<ref-ruling> E. 2a mit Hinweisen; <ref-ruling> E. 3a S. 373). Und dass Letzteres der Fall sein soll, kann mit den bloss appellatorischen Vorbringen des Beschwerdeführers nicht dargetan werden. Indem das Kassationsgericht den vom Obergericht festgesetzten Stundenlohn von Fr. 108.-- (zuzüglich 7.6 % MwSt.) gebilligt hat, welcher um Fr. 27.-- tiefer lag als der vom Beschwerdeführer gegenüber der E._ AG verrechnete, ist es nicht in Willkür verfallen.
4. Nach dem Ausgeführten ist die Beschwerde abzuweisen, soweit darauf eingetreten werden kann. Der Beschwerdeführer wird damit kostenpflichtig (<ref-law>), denn sein Gesuch um unentgeltliche Rechtspflege konnte von vornherein keine Aussicht auf Erfolg haben (<ref-law>). Die Zusprechung einer Parteientschädigung an die Beschwerdegegnerin entfällt, da sie nicht zur Vernehmlassung aufgefordert wurde (vgl. <ref-law>).

Demnach erkennt das Bundesgericht:
1. Die Beschwerde wird abgewiesen, soweit darauf einzutreten ist.
2. Das Gesuch um unentgeltliche Rechtspflege wird abgewiesen.
3. Die Gerichtskosten von Fr. 2'500.-- werden dem Beschwerdeführer auferlegt.
4. Dieses Urteil wird den Parteien und dem Kassationsgericht des Kantons Zürich schriftlich mitgeteilt.
Lausanne, 29. Oktober 2008
Im Namen der II. zivilrechtlichen Abteilung
des Schweizerischen Bundesgerichts
Der Präsident: Der Gerichtsschreiber:
Raselli Schett